org.mbari.siam.devices.ocr3000
Class Ocr3000

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.ocr3000.Ocr3000

All Implemented Interfaces:

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

public class Ocr3000
extends PolledInstrumentService
implements Instrument

Class description

Version:

$Id: Ocr3000.java,v 1.4 2009/07/16 22:01:08 headley Exp $

Author:

Enter your name here...

See Also:

Serialized Form

Nested Class Summary

static class	Ocr3000.CalibrationInfo Encapulates the calibration information contained in a single calibration file.
static class	Ocr3000.DataStructure A structure encapsulating access to engineering units for the measurements in a single record.
class	Ocr3000.DevicePacketParser This class generates JDDAC records that are used by the instrumentServiceBlock
class	Ocr3000.OCRServiceBlock A specialized InstrumentService Block.
static class	Ocr3000.SensorDefinition A represents a single line and related coefficeints from a HyperOCR calibration file.

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

Ocr3000()
Constructs ...

Method Summary

protected ScheduleSpecifier	createDefaultSampleSchedule() Return specifier for default sampling schedule.
DevicePacketParser	getDevicePacketParser() Get instruments' DevicePacketParser, which returns JDDAC records.
InstrumentServiceBlock	getInstrumentServiceBlock() Retrive the FunctionBlock used for specialized processing of acquired samples.
protected byte[]	getInstrumentStateMetadata() Return instrument metadata.
SerialPortParameters	getSerialPortParameters() Return parameters to use on serial port.
protected PowerPolicy	initCommunicationPowerPolicy() Sets communications power policy
protected int	initCurrentLimit() Sets current limit
protected void	initializeInstrument() Initialize the OCR-3000.
protected PowerPolicy	initInstrumentPowerPolicy() Sets power policy
protected int	initInstrumentStartDelay() Set startup delay time
protected int	initMaxSampleBytes() Sets the maximum number of bytes in a instrument data sample
protected byte[]	initPromptString() Sets the command prompt
protected byte[]	initSampleTerminator() Sets the sample terminator
protected int	readSample(byte[] sample) Read raw sample bytes from serial port into buffer, return number of bytes read.
protected void	requestSample() Request a sample from the instrument
void	setClock(long time) Set the instruments clock.
int	test() Self-test routine.

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, getFileBytes, getInstrumentPowerPolicy, 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, 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

Ocr3000

public Ocr3000()
        throws java.rmi.RemoteException

Constructs ...

Throws:

java.rmi.RemoteException

Method Detail

createDefaultSampleSchedule

protected ScheduleSpecifier createDefaultSampleSchedule()
                                                 throws ScheduleParseException

Return specifier for default sampling schedule.

Specified by:

createDefaultSampleSchedule in class PolledInstrumentService

Throws:

ScheduleParseException

initCommunicationPowerPolicy

protected PowerPolicy initCommunicationPowerPolicy()

Sets communications power policy

Specified by:

initCommunicationPowerPolicy in class BaseInstrumentService

initCurrentLimit

protected int initCurrentLimit()

Sets current limit

Specified by:

initCurrentLimit in class BaseInstrumentService

initInstrumentPowerPolicy

protected PowerPolicy initInstrumentPowerPolicy()

Sets power policy

Specified by:

initInstrumentPowerPolicy in class BaseInstrumentService

initInstrumentStartDelay

protected int initInstrumentStartDelay()

Set startup delay time

Specified by:

initInstrumentStartDelay in class BaseInstrumentService

initMaxSampleBytes

protected int initMaxSampleBytes()

Sets the maximum number of bytes in a instrument data sample

Specified by:

initMaxSampleBytes in class BaseInstrumentService

initPromptString

protected byte[] initPromptString()

Sets the command prompt

Specified by:

initPromptString in class BaseInstrumentService

initSampleTerminator

protected byte[] initSampleTerminator()

Sets the sample terminator

Specified by:

initSampleTerminator in class BaseInstrumentService

initializeInstrument

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

Initialize the OCR-3000.

Overrides:

initializeInstrument in class BaseInstrumentService

Throws:

InitializeException

java.lang.Exception

readSample

protected int readSample(byte[] sample)
                  throws TimeoutException,
                         java.io.IOException,
                         java.lang.Exception

Description copied from class: BaseInstrumentService

Read raw sample bytes from serial port into buffer, return number of bytes read. Reads characters from serial port until sample terminator string is encountered.

Overrides:

readSample in class BaseInstrumentService

Parameters:

sample - output buffer

Throws:

TimeoutException

java.io.IOException

java.lang.Exception

requestSample

protected void requestSample()
                      throws java.io.IOException

Request a sample from the instrument

Specified by:

requestSample in class PolledInstrumentService

Throws:

java.io.IOException

test

public int test()

Self-test routine.

Specified by:

test in interface Device

Returns:

an integer

getInstrumentStateMetadata

protected byte[] getInstrumentStateMetadata()

Return instrument metadata.

Overrides:

getInstrumentStateMetadata in class BaseInstrumentService

getInstrumentServiceBlock

public InstrumentServiceBlock getInstrumentServiceBlock()

Description copied from class: BaseInstrumentService

Retrive the FunctionBlock used for specialized processing of acquired samples. By default it will return a SummaryBlock if the following conditions are met:

• The getInstrumentService has not been overridden
• A DevicePacketParser is returned from getDevicePacketParser()
• getAttributes() returns an instance of InstrumentServiceAttributes. Most Services will do this by default.
• attributes.maxSummarySamples has been set to greater than 0
• attributes.summaryTriggerCount has been set to greater than 0
• attributes.summaryVars has been set with a valid String[]

Overrides:

getInstrumentServiceBlock in class BaseInstrumentService

Returns:

The JDDAC FunctionBlock used for specialized processing of aquired samples.

getSerialPortParameters

public SerialPortParameters getSerialPortParameters()
                                             throws gnu.io.UnsupportedCommOperationException

Return parameters to use on serial port.

Overrides:

getSerialPortParameters in class DeviceService

Returns:

SerialPortParameters for this instrument's serial port

Throws:

gnu.io.UnsupportedCommOperationException

setClock

public void setClock(long time)

Set the instruments clock.

Specified by:

setClock in interface Instrument

Overrides:

setClock in class BaseInstrumentService

Parameters:

time -

getDevicePacketParser

public DevicePacketParser getDevicePacketParser()
                                         throws NotSupportedException

Description copied from class: BaseInstrumentService

Get instruments' DevicePacketParser, which returns JDDAC records. Not supported by default

Overrides:

getDevicePacketParser in class BaseInstrumentService

Throws:

NotSupportedException