org.mbari.siam.devices.valve
Class ValveService

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.valve.ValveService

All Implemented Interfaces:

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

public class ValveService
extends PolledInstrumentService
implements Instrument, ValveServiceIF

ValveService implements a service to control 1-4 Hanbay MDx-xxxDT valves controlled by a B&B Electronics 232SDD16 Serial-to-Digital-I/O module.

It implements ValveServiceIF, which means that it can return up to 4 ValveIF objects, each of which controls a single valve.

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger	_log4j Log4j logger
protected byte[]	_nullBytes
protected int	_sampleBytes

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

Fields inherited from interface org.mbari.siam.distributed.devices.ValveServiceIF

MAX_VALVES, VALVE_AFT, VALVE_EXTRA0, VALVE_EXTRA1, VALVE_FWD

Constructor Summary

ValveService()

Method Summary

protected ScheduleSpecifier	createDefaultSampleSchedule() Return specifier for default sampling schedule.
protected byte[]	getInstrumentStateMetadata() Return metadata.
PacketParser	getParser() Return a PacketParser.
SerialPortParameters	getSerialPortParameters() Return parameters to use on serial port.
ValveIF	getValve(int valveNum) Get a ValveIF for the given valveNum.
ValveControl	getValveControl(int valveNum) Get a ValveControl for the given valveNum.
protected PowerPolicy	initCommunicationPowerPolicy() Return initial value of communication power policy.
protected int	initCurrentLimit() Specify current limit.
protected void	initializeInstrument() Do instrument- and service-specific initialization.
protected PowerPolicy	initInstrumentPowerPolicy() Return initial value of instrument power policy.
protected int	initInstrumentStartDelay() Specify device startup delay (millisec)
protected int	initMaxSampleBytes() Specify maximum bytes in raw sample.
protected byte[]	initPromptString() Specify prompt string.
protected byte[]	initSampleTerminator() Specify sample terminator.
protected int	readSample(byte[] sample) Acquire Data
protected void	requestSample() Request a data sample
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, 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, removeAllSchedules, removeSchedule, resetPortDiagnostics, resume, resumeSchedule, running, setClock, 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, getPortDiagnostics, getPortDiagnosticsSummary, getProperties, getProperty, getSampleSchedule, getSchedules, resetPortDiagnostics, setClock, 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

Field Detail

_log4j

protected static org.apache.log4j.Logger _log4j

Log4j logger

_nullBytes

protected final byte[] _nullBytes

_sampleBytes

protected int _sampleBytes

Constructor Detail

ValveService

public ValveService()
             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

initInstrumentStartDelay

protected int initInstrumentStartDelay()

Specify device startup delay (millisec)

Specified by:

initInstrumentStartDelay in class BaseInstrumentService

initPromptString

protected byte[] initPromptString()

Specify prompt string.

Specified by:

initPromptString in class BaseInstrumentService

initSampleTerminator

protected byte[] initSampleTerminator()

Specify sample terminator.

Specified by:

initSampleTerminator in class BaseInstrumentService

initMaxSampleBytes

protected int initMaxSampleBytes()

Specify maximum bytes in raw sample.

Specified by:

initMaxSampleBytes in class BaseInstrumentService

initCurrentLimit

protected int initCurrentLimit()

Specify 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 communication power policy.

Specified by:

initCommunicationPowerPolicy in class BaseInstrumentService

requestSample

protected void requestSample()
                      throws java.lang.Exception

Request a data sample

Specified by:

requestSample in class PolledInstrumentService

Throws:

java.lang.Exception

initializeInstrument

protected void initializeInstrument()
                             throws InitializeException,
                                    java.lang.Exception

Description copied from class: BaseInstrumentService

Do instrument- and service-specific initialization. By default, this method does nothing, and may be overridden.

Overrides:

initializeInstrument in class BaseInstrumentService

Throws:

InitializeException

java.lang.Exception

getValveControl

public ValveControl getValveControl(int valveNum)
                             throws RangeException,
                                    java.io.IOException

Get a ValveControl for the given valveNum.

Throws:

RangeException

java.io.IOException

getValve

public ValveIF getValve(int valveNum)
                 throws RangeException,
                        java.io.IOException

Get a ValveIF for the given valveNum. Supports the getValve() method of ValveIF.

Specified by:

getValve in interface ValveServiceIF

Throws:

RangeException

java.io.IOException

readSample

protected int readSample(byte[] sample)
                  throws java.lang.Exception

Acquire Data

Overrides:

readSample in class BaseInstrumentService

Parameters:

sample - output buffer

Throws:

java.lang.Exception

getInstrumentStateMetadata

protected byte[] getInstrumentStateMetadata()

Return metadata.

Overrides:

getInstrumentStateMetadata in class BaseInstrumentService

createDefaultSampleSchedule

protected ScheduleSpecifier createDefaultSampleSchedule()
                                                 throws ScheduleParseException

Return specifier for default sampling schedule.

Specified by:

createDefaultSampleSchedule in class PolledInstrumentService

Throws:

ScheduleParseException

getSerialPortParameters

public SerialPortParameters getSerialPortParameters()
                                             throws gnu.io.UnsupportedCommOperationException

Return parameters to use on serial port.

Overrides:

getSerialPortParameters in class DeviceService

Throws:

gnu.io.UnsupportedCommOperationException

getParser

public PacketParser getParser()
                       throws NotSupportedException

Return a PacketParser.

Specified by:

getParser in interface Instrument

Overrides:

getParser in class BaseInstrumentService

Throws:

NotSupportedException

test

public int test()

Self-test routine; not yet implemented.

Specified by:

test in interface Device