org.mbari.siam.distributed
Interface Sensor

All Superinterfaces:

Device, java.rmi.Remote

public interface Sensor
extends Device

A Sensor is a Device that can acquire data.

Author:

Tom O'Reilly

Field Summary

static int	ACQUIRE_MODE Mode; sensor should automatically acquire samples
static int	STANDBY_MODE Mode; Sensor should not automatically acquire samples

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

Calibration	getCalibration() Get latest Calibration.
DevicePacket	getCurrentData() Get most recent DevicePacket.
SensorDataHandler	getDataHandler() Get the SensorDataHandler.
DevicePacketStream	getPacketStream() Get DevicePacketStream for this Sensor.
void	sleep() Put sensor in "sleep" mode (stop taking data).
void	wakeup() Bring sensor out of "sleep" mode (start taking data).

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

Field Detail

ACQUIRE_MODE

static final int ACQUIRE_MODE

Mode; sensor should automatically acquire samples

See Also:

Constant Field Values

STANDBY_MODE

static final int STANDBY_MODE

Mode; Sensor should not automatically acquire samples

See Also:

Constant Field Values

Method Detail

getCurrentData

DevicePacket getCurrentData()
                            throws java.rmi.RemoteException,
                                   java.lang.Exception

Get most recent DevicePacket.

Throws:

java.rmi.RemoteException

java.lang.Exception

getPacketStream

DevicePacketStream getPacketStream()
                                   throws java.rmi.RemoteException,
                                          java.lang.Exception

Get DevicePacketStream for this Sensor.

Throws:

java.rmi.RemoteException

java.lang.Exception

getCalibration

Calibration getCalibration()
                           throws java.rmi.RemoteException,
                                  java.lang.Exception

Get latest Calibration.

Throws:

java.rmi.RemoteException

java.lang.Exception

getDataHandler

SensorDataHandler getDataHandler()
                                 throws java.rmi.RemoteException,
                                        java.lang.Exception

Get the SensorDataHandler.

Throws:

java.rmi.RemoteException

java.lang.Exception

sleep

void sleep()
           throws java.rmi.RemoteException,
                  java.lang.Exception

Put sensor in "sleep" mode (stop taking data).

Throws:

java.rmi.RemoteException

java.lang.Exception

wakeup

void wakeup()
            throws java.rmi.RemoteException,
                   java.lang.Exception

Bring sensor out of "sleep" mode (start taking data).

Throws:

java.rmi.RemoteException

java.lang.Exception