org.mbari.siam.distributed.devices
Interface Environmental

All Superinterfaces:
Device, Instrument, java.rmi.Remote
All Known Implementing Classes:
MSP430

public interface Environmental
extends Instrument

Interface to provide Environmental Service

Author:
Bob Herlien

Nested Class Summary
static class Environmental.Data
          Container for environmental data.
 
Field Summary
 
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
 
Method Summary
 Environmental.Data getDataValues(boolean logData)
          Get the latest data sample.
 void resetTurnsCounter(int nTurns)
          Reset the compass turns counter to specified count.
 
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, 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, test
 

Method Detail

resetTurnsCounter

void resetTurnsCounter(int nTurns)
                       throws java.rmi.RemoteException
Reset the compass turns counter to specified count.

Throws:
java.rmi.RemoteException

getDataValues

Environmental.Data getDataValues(boolean logData)
                                 throws NoDataException,
                                        java.rmi.RemoteException
Get the latest data sample.

Throws:
NoDataException
java.rmi.RemoteException


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.