org.mbari.siam.devices.medusa
Class Medusa

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              org.mbari.siam.core.DeviceService
                  org.mbari.siam.core.BaseInstrumentService
                      org.mbari.siam.core.PolledInstrumentService
                          org.mbari.siam.devices.medusa.Medusa

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, ScheduleOwner, Device, NetworkSwitch, DeviceServiceIF, Instrument

public class Medusa
extends PolledInstrumentService
implements NetworkSwitch

Service for Medusa optical interface card.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mbari.siam.core.BaseInstrumentService

_defaultSamplerTask, _defaultSampleScheduleName, _errorCache, _instrumentAttributes, _lastPacket, _lastSensorDataPacket, _maxSampleBytes, _messagePacket, _nPowerRequests, _nWakeRequests, _packetLog, _recordType, _running, _samplerWakeupTime, _scheduleKey, _schedules, _sensorDataPacket, _turbinator, MAX_BASE_RECORDTYPE, RECORDTYPE_DEFAULT, RECORDTYPE_METADATA, RECORDTYPE_UNDEFINED

Fields inherited from class org.mbari.siam.core.DeviceService

_fromDevice, _instrumentPort, _nodeProperties, _parentNode, _regEntry, _sandBox, _serviceCachePath, _serviceName, _servicePropertiesPath, _serviceXMLPath, _toDevice, CACHED_PROPERTIES_FILENAME, PROPERTIES_FILENAME, XML_FILENAME

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.mbari.siam.distributed.Device

ERROR, INITIAL, INSTRUMENT_STATE, MDATA_ALL, OK, SAFE, SAMPLING, SERVICE_ATTRIBUTES, SERVICE_CACHE, SERVICE_PROPERTIES, SERVICE_XML, SHUTDOWN, SLEEPING, SUSPEND, UNKNOWN

Constructor Summary

Medusa()
Constructor.

Method Summary

protected ScheduleSpecifier	createDefaultSampleSchedule() Return specifier for default sampling schedule.
java.net.InetAddress	getCpuAddress() Get Medusa cpu IP address
protected byte[]	getInstrumentStateMetadata() Return metadata.
protected void	getPrompt() Get prompt character from Medusa.
SerialPortParameters	getSerialPortParameters() Return parameters to use on serial port.
protected PowerPolicy	initCommunicationPowerPolicy() Return initial value of instrument power policy.
protected int	initCurrentLimit() Return initial value of DPA current limit.
protected void	initializeInstrument() Initialize the Medusa.
protected PowerPolicy	initInstrumentPowerPolicy() Return initial value of instrument power policy.
protected int	initInstrumentStartDelay() Return initial value of instrument startup time in millisec.
protected int	initMaxSampleBytes() Return initial value for maximum number of bytes in a instrument data sample.
protected byte[]	initPromptString() Return initial value for instrument's "prompt" character.
protected byte[]	initSampleTerminator() Return initial value for instrument's sample terminator
protected void	requestSample() Get a Medusa sample, which includes diagnostic information.
void	setClock(long epochMsec) Set Medusa's clock.
int	test() Self-test routine; not yet implemented.

Methods inherited from class org.mbari.siam.core.PolledInstrumentService

acquire, doScheduledTask, setAttributes

Methods inherited from class org.mbari.siam.core.BaseInstrumentService

acquireSample, addDefaultPacketFilters, addSchedule, addSchedule, annotate, assertSamplingState, cacheProperties, callDataListeners, canSummarize, checkInputProperties, cleanupServiceState, clearDefaultPacketFilters, clearPropertiesCache, createPacketLog, createTask, createTurbinators, disableSummary, enableSummary, endDeviceAccess, getAllSchedules, getChildren, getCommunicationPowerPolicy, getCurrentLimit, getDefaultPacketFilters, getDefaultSampleSchedule, getDefaultSampleScheduleName, getDevicePacketParser, getFileBytes, getInstrumentPowerPolicy, getInstrumentServiceBlock, getInstrumentStartDelay, getLastSample, getMaxSampleBytes, getMaxSampleTries, getMetadata, getMetadata, getMetadataPayload, getPackets, getPackets, getParent, getParser, getPortDiagnostics, getPortDiagnosticsSummary, getPromptString, getProperties, getProperty, getSampleBuf, getSampleSchedule, getSampleTerminator, getSampleTimeout, getSchedule, getScheduleKey, getSchedules, getServicePropertiesBytes, initialize, initializeDriverDefaults, initializePooledResources, interruptDeviceAccess, logPacket, managePowerSleep, managePowerWake, nPowerRequests, postSample, powerOff, powerOffCallback, powerOn, powerOnCallback, prepareToRun, prepareToSample, printData, processSample, readSample, removeAllSchedules, removeSchedule, resetPortDiagnostics, resume, resumeSchedule, running, setClock, setCommunicationPowerPolicy, setCurrentLimit, setDefaultSampleScheduleName, setInstrumentPowerPolicy, setInstrumentServiceBlock, setInstrumentStartDelay, setMaxSampleBytes, setMaxSampleTries, setPromptString, setProperty, setRecordType, setSampleTerminator, setSampleTimeout, shutdown, shutdownInstrument, sleepingUntil, snooze, startDeviceAccess, summaryEnabled, suspend, suspendSchedule, sync, syncSchedule, validateSample

Methods inherited from class org.mbari.siam.core.DeviceService

addDataListener, advertiseService, createRegistryEntry, getAttributes, getCommPortName, getFrameworkVersion, getId, getInstrumentPort, getLocation, getName, getRemoteSerialPort, getRemoteSerialPort, getSamplingCount, getSamplingErrorCount, getSamplingRetryCount, getStatus, host, incRetryCount, initializePropertyDefaults, registryEntry, registryName, removeDataListener, setInstrumentPort, setNodeProperties, setParent, setSerialPort, setStatusError, setStatusInitial, setStatusOk, setStatusSafe, setStatusSampling, setStatusShutdown, setStatusSuspend

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mbari.siam.distributed.Instrument

acquireSample, addDefaultPacketFilters, annotate, cacheProperties, clearDefaultPacketFilters, clearPropertiesCache, disableSummary, enableSummary, getDefaultPacketFilters, getLastSample, getPackets, getPackets, getParser, getPortDiagnostics, getPortDiagnosticsSummary, getProperties, getProperty, getSampleSchedule, getSchedules, resetPortDiagnostics, setClock, setProperty, summaryEnabled

Methods inherited from interface org.mbari.siam.distributed.Device

getChildren, getCommPortName, getFrameworkVersion, getId, getLocation, getMetadata, getName, getParent, getSamplingCount, getSamplingErrorCount, getSamplingRetryCount, getStatus, host, powerOff, powerOn, prepareToRun, resume, shutdown, suspend

Methods inherited from interface org.mbari.siam.distributed.DeviceServiceIF

getName

Methods inherited from interface org.mbari.siam.core.ScheduleOwner

addSchedule, getAllSchedules, getScheduleKey, removeAllSchedules, removeSchedule, resumeSchedule, sleepingUntil, suspendSchedule, syncSchedule

Constructor Detail

Medusa

public Medusa()
       throws java.rmi.RemoteException

Constructor.

Throws:

java.rmi.RemoteException

Method Detail

initPromptString

protected byte[] initPromptString()

Return initial value for instrument's "prompt" character.

Specified by:

initPromptString in class BaseInstrumentService

initSampleTerminator

protected byte[] initSampleTerminator()

Return initial value for instrument's sample terminator

Specified by:

initSampleTerminator in class BaseInstrumentService

initCurrentLimit

protected int initCurrentLimit()

Return initial value of DPA current limit.

Specified by:

initCurrentLimit in class BaseInstrumentService

initInstrumentPowerPolicy

protected PowerPolicy initInstrumentPowerPolicy()

Return initial value of instrument power policy.

Specified by:

initInstrumentPowerPolicy in class BaseInstrumentService

initCommunicationPowerPolicy

protected PowerPolicy initCommunicationPowerPolicy()

Return initial value of instrument power policy.

Specified by:

initCommunicationPowerPolicy in class BaseInstrumentService

initInstrumentStartDelay

protected int initInstrumentStartDelay()

Return initial value of instrument startup time in millisec.

Specified by:

initInstrumentStartDelay in class BaseInstrumentService

initMaxSampleBytes

protected int initMaxSampleBytes()

Return initial value for maximum number of bytes in a instrument data sample.

Specified by:

initMaxSampleBytes in class BaseInstrumentService

requestSample

protected void requestSample()

Get a Medusa sample, which includes diagnostic information.

Specified by:

requestSample in class PolledInstrumentService

getPrompt

protected void getPrompt()
                  throws TimeoutException,
                         java.io.IOException,
                         java.lang.NullPointerException,
                         java.lang.Exception

Get prompt character from Medusa.

Throws:

TimeoutException

java.io.IOException

java.lang.NullPointerException

java.lang.Exception

test

public int test()

Self-test routine; not yet implemented.

Specified by:

test in interface Device

initializeInstrument

protected void initializeInstrument()
                             throws java.lang.Exception

Initialize the Medusa.

Overrides:

initializeInstrument in class BaseInstrumentService

Throws:

java.lang.Exception

getSerialPortParameters

public SerialPortParameters getSerialPortParameters()
                                             throws gnu.io.UnsupportedCommOperationException

Return parameters to use on serial port.

Overrides:

getSerialPortParameters in class DeviceService

Throws:

gnu.io.UnsupportedCommOperationException

createDefaultSampleSchedule

protected ScheduleSpecifier createDefaultSampleSchedule()
                                                 throws ScheduleParseException

Return specifier for default sampling schedule.

Specified by:

createDefaultSampleSchedule in class PolledInstrumentService

Throws:

ScheduleParseException

setClock

public void setClock(long epochMsec)

Set Medusa's clock.

Specified by:

setClock in interface Instrument

Overrides:

setClock in class BaseInstrumentService

getInstrumentStateMetadata

protected byte[] getInstrumentStateMetadata()

Return metadata.

Overrides:

getInstrumentStateMetadata in class BaseInstrumentService

getCpuAddress

public java.net.InetAddress getCpuAddress()
                                   throws java.net.UnknownHostException

Get Medusa cpu IP address

Specified by:

getCpuAddress in interface NetworkSwitch

Throws:

java.net.UnknownHostException