Package org.mbari.siam.distributed

Classes and interfaces used in SIAM client-service transactions

See:
Description

Interface Summary

AttributeChecker	AttributeChecker has callbacks that are invoked as attributes are parsed.
Device	Interface to a device that can be remotely controlled.
DeviceLogIF	DeviceLogIF is the interface for a DevicePacket logger
DeviceServiceIF	Interface between a ServiceAttributes object and the DeviceService that contains contains it.
EventManager	Waits for and responds to asynchronous events from its Platform's components, including Devices.
Exportable	SiamSerializable is an interface implemented by exportable objects that generate java-independent serialized forms.
FilteredDeviceLogIF	FilteredDeviceLogIF is the interface for a DevicePacket logger
FOCENode	FOCENode interface.
Importable	An Importable object is capable of being input from a string...
Instrument	An Instrument is a Device that can acquire data.
Mnemonic	A Mnemonic has "mnemonic string representations that can be converted to an instance of the object.
MOOSNode	Interface to MOOSNode, which hosts devices.
MotorControlIF	Presents and interface implementing motor control.
NetworkManager	NetworkManager defines the methods to manage power and communications on the MOOS deployed network.
Node	Interface to an ISI Node, which hosts devices.
NodeConfigurator	NodeConfigurator encapsulates the configuration of hardware-dependent components
NodeEventCallback	NodeService uses this interface to invoke remote callbacks when significant local events are detected.
NodeEventListener	NodeEventListener gets notified by NodeEventCallback service when signficant event occurs on Node.
Parent	Parent represents the processing/management environment into which an Instrument is installed.
Platform	A Platform contains and manages a collection of Devices.
PowerPort	Interface to control a device's power.
RemoteService	Extends Remote, including method to 'ping' the remote service.
Safeable	Safeable interface is implemented by instruments that can operate in a resource-restricted environment ("safe mode") as well as the nominal environment ("normal mode").
ScheduledSummarizer	A ScheduledSummarizer generates summaries on a specified schedule.
Sensor	A Sensor is a Device that can acquire data.
SensorDataHandler	Implementations of SensorDataHandler know how to parse, compress, print, summarize sensor-specific data.
SequenceGenerator	A SequenceGenerator generates a (thread-safe) sequence of (long) integers.
ShoreMessaging	Service interface for shore messaging facility.
SleepRollCallListener	Interface to allow interested parties to add callbacks to SleepManager.
Summarizer	This interface should be implemented by instrument services that can produce summary packets.
Temperature	Temperature

Class Summary

AttributeValueObject	AttributeValueObject
Authentication	Authentication is provided by client for secure operations.
BooleanAttributeValueObject	BooleanAttributeValueObject - The value for state attributes which have Boolean values.
ByteArrayAttributeValueObject	ByteArrayAttributeValueObject - The value for state attributes which have byte array (byte[]) values.
Calibration	Sensor calibration information.
Calibration.Coefficient
CommsMode	CommsMode specifies the commumincations mode to be applied to a device's communication channel.
CTDData	CTDData
DeviceConfiguration	DeviceConfiguration is the interface to "low-level" configuration functions of a Device; hides details of device implementation.
DeviceGeometry	DeviceGeometry specifies geometric offsets of all Device objects managed by a Platform.
DeviceInfo	DeviceInfo contains 'metadata' associated with a device.
DeviceMessagePacket	DeviceMessagePacket contains a text message from a device.
DevicePacket	DevicePacket is a container for data or metadata which originates at a particular device, and forms the base of a packet class hierarchy, which includes SensorDataPacket, DeviceMessagePacket, and MetadataPacket.
DevicePacketOutputStream	DevicePacketOutputStream serializes DevicePacket objects and writes them to a Socket.
DevicePacketParser	A DevicePacketParser generates JDDAC Records from SIAM DevicePackets.
DevicePacketServerThread	Base class for thread which accepts DevicePacketStream client connections.
DevicePacketSet	A DevicePacketSet contains a vector of DevicePacket objects, and indicates whether the vector is a "complete" set of packets.
DevicePacketStream	DevicePacketStream is a source of DevicePacket objects.
DevicePacketStreamFactory	DevicePacketStreamFactory creates DevicePacketStream objects.
DoubleAttributeValueObject	DoubleAttributeValueObject - The value for state attributes which have Integer values.
FloatAttributeValueObject	FloatAttributeValueObject - The value for state attributes which have Integer values.
InstrumentServiceAttributes	InstrumentServiceAttributes and its base class ServiceAttributes provide a framework for representation of instrument service state, which is an important component of service metadata.
IntegerAttributeValueObject	IntegerAttributeValueObject - The value for state attributes which have Integer values.
LatLonDepth	Location captures the nominal physical location of an ISI device (Not, in general, to a precision or accuracy suitable for scientific purposes).
Location	Location captures the nominal physical location of an ISI device (Not, in general, to a precision or accuracy suitable for scientific purposes).
LongAttributeValueObject	LongAttributeValueObject - The value for state attributes which have Integer values.
MeasurementPacket	MeasurementPacket contains a SiamRecord, which is composed of a series of SiamMeasurement objects.
MetadataPacket	MetadataPacket contains information relating to "state" of the generating device.
MnemonicIntegerAttributeValueObject	MnemonicIntegerAttributeValueObject - The value for state attributes which have mnemonics that represent integer values (e.g., powerPolicy -- "never":0; "sampling":1; etc.).
MOOSNodeInfo
MOOSNodeNotifyMessage	Basic info specific to MOOS node, periodically sent to node's parent.
MOOSSubnode	MOOS subnode description
NodeInfo	Basic information about node and its subnodes
NodeNotifyMessage	NodeNotifyMessage defines some very basic information about a node, and is periodically sent to the node's parent.
NodePacketTypes	NodePacketTypes defines SensorDataPacket "record types" generated by Node.
NodeSessionInfo	NodeSessionInfo contains information returned by the node at the start of a "telemetry" session, including list of the node's ports, subnodes and other information.
PacketFilter	Specifies filtering criteria for specified packet types.
PacketParser	Parses DevicePacket packets.
PacketSubsampler	PacketSubsampler filters every nth packet of specified types.
Port	A Port represents a node's instrument communication port.
PortConfiguration
PowerPolicy	PowerPolicy specifies how power should be applied to a device or to the device's communication channel.
PowerSwitch	The PowerSwitch class contains information about power switches.
RelCartesian	Location captures the nominal physical location of an ISI device (Not, in general, to a precision or accuracy suitable for scientific purposes).
RemoteSerialPort	RemoteSerialPort provides a network communication channel to a DeviceService's serial port.
ScheduleSpecifier	The ScheduleSpecifier class implements the portion of a schedule (entry) that specifies at what times the job portion of the schedule is to be executed.
ScheduleSpecifierAttributeValueObject	ScheduleSpecifierAttributeValueObject - The value for state attributes which have ScheduleSpecifier values.
SensorDataPacket	SensorDataPacket contains "raw" bytes read from a sensor.
SensorStatusPacket	Deprecated. Replaced by MetadataPacket
ServiceAttributes	The ServiceAttributes class provides a framework for representation of service state, which is an important component of service metadata.
ShoreMessagingHelper	Various attributes and classes associated with ShoreMessaging
ShoreMessagingHelper.Message	Message to be downlinked
StateAttribute	StateAttribute is a class from which all StateAttributes inherit.
Subnode	This class represents a subnode.
SummaryPacket	SummaryPacket contains a "summary" of multiple data samples.
Velocity	Velocity
ZeroConf	ZeroConf defines naming conventions for SIAM ZeroConf interface

Exception Summary

AuthenticationException	Thrown when unauthorized operation is attempted.
DeviceNotFound	Thrown when unknown device is specified.
DuplicateIdException	InvalidPropertyException is thrown when an invalid property is specified.
ExportException	ExportException
InitializeException	Thrown during initialization
InvalidDataException	InvalidDataException is thrown when invalid data is determined.
InvalidPropertyException	InvalidPropertyException is thrown when an invalid property is specified.
MissingPropertyException	MissingPropertyException is thrown when a required property is missing.
NoChildrenException	Indicates that a Device has no children.
NoDataException	Thrown when no data is available.
NoParentException	Indicates that Device has no parent.
NotConnectedException	Thrown when client/server app is not connected to server
NotSupportedException	Thrown when an operation is not supported
PortNotFound	Thrown when unknown port is specified.
PortOccupiedException	Thrown when trying to scan port, but service is already using port
PropertyException	PropertyException is thrown when a property-related error occurs
PuckIOException	Thrown when communications with the puck fails
RangeException	RangeException indicates that an input argument had a value outside of the valid range.
ScheduleParseException	ScheduleParseException indicates that an entry used incorrect syntax
ShoreMessagingHelper.ConnectFailed
ShoreMessagingHelper.MessageTooBig
ShoreMessagingHelper.ModemInUse
TimeoutException	TimeoutException indicates when a some operation has timed out.
TooMuchDataException	Thrown when "too much" data has been requested.
UnknownLocationException	Indicates that Device location is unknown.

Package org.mbari.siam.distributed Description

Classes and interfaces used in SIAM client-service transactions