Package org.mbari.siam.core

Components that execute on deployed at-sea processor when used on low-bandwidth-to-shore systems such as moorings; on cable-to-shore systems these components may actually execute on shore; includes the instrument service framework.

See:
          Description

Interface Summary
CommListener CommListener is an interface that must be implemented by objects that wish to intercept CommEvents.
DevicePacketAggregator.DevicePacketSource Interface class that defines a source of DevicePackets.
HostEnvironment Individual instrument services run in a "host environment".
InstrumentPort Interface that encompasses power control and communications to an instrument.
IoResource  
LogSampleListener LogSampleListener is an interface that must be implemented by objects that wish to intercept LogSampleServiceEvents.
PowerListener PowerListener is an interface that must be implemented by objects that wish to intercept PowerEvents.
Puck  
QueueDispatcher  
Schedulable Interface for objects that may be scheduled.
ScheduleOwner Interface for objects that own scheduled tasks
SchedulerListener SchedulerListener is an interface that must be implemented by objects that wish to intercept SchedulerEvents.
ServiceListener ServiceListener is an interface that must be implemented by objects that wish to intercept ServiceEvents.
 

Class Summary
AggregateInstrumentService This class serves as a base class for instruments that are supervised by a single controller (eg SeaBird37im.java).
AlarmClock AlarmClock lets a service thread go to sleep in such a way that SleepManager could also put the processor to sleep while the service thread is sleeping, but the processor will wake up in time for the thread wakeup.
AnalogDevicePort AnalogDevicePort implements DevicePort for an A/D port.
AnalogInstrumentPort Implements power control and communications to an instrument via analog port.
AuxComms The AuxComms subsystem implements an "auxillary" ppp link.
BaseInstrumentPort Implements power control and communications to an instrument via serial port.
BaseInstrumentService BaseInstrumentService is the base class of an "application framework" for instruments which communicate through a serial port
ChannelParameters  
ChannelRange  
CommEvent Comm Event
CommsLeaseListener CommsLeaseListener responds to the Node's LeaseManager leasing events, and in response carries out several tasks to manage the relationship with the node's "parent" node.
CommStatus CommStatus generates information about health and status of the node's communication interfaces.
CpuLease CpuLease is responsible for keeping the CPU awake as requested by external processes.
CpuLeaseSleepRollcallListener CpuLeaseSleepRollcallListener is responsible for keeping the CPU awake as requested by external processes.
DebugMessage  
DeviceLog DeviceLog is the top level class implementation of an indexed record retrieval class.
DeviceLogData This class implements the serialized class storage and retrieval functions needed by the DeviceLog class.
DeviceLogIndex This class is utilized along with DeviceLogData to implement an indexed data store capability.
DeviceLogIndex.Entry This class provides a container for each indexing information entry.
DeviceLogIndex.JournalEntry This class provides a container for log journal information.
DeviceLogIterator DeviceLogIterator iterates over DevicePackets stored in a DeviceLog.
DevicePacketAggregator DevicePacketAggregator implements two new method signatures of getDevicePackets() on behalf of the Node interface.
DevicePacketPublisher DevicePacketPublisher instantiates an SSDS PublisherComponent and uses it to publish DevicePackets.
DevicePort DevicePort specifies deviceID and service associated with a Device port.
DeviceService DeviceService implements the Device interface.
DeviceServiceClassLoader Load DeviceService classes from jar file.
DigitalInputDevicePort DigitalInputDevicePort implements DevicePort for Digital Input bits on an AnalogBoard
DigitalInputInstrumentPort Implements InstrumentPort interface for a digital input port.
EventManager EventManager is a mechanism for notifying objects of system level events.
EventTest  
FilteredDeviceLog FilteredDeviceLog enables retrieval of DevicePackets based on filtering criteria.
HostStatus HostStatus generates information about health and status of the SIAM host computer.
HttpInstrumentPort InstrumentPort implementation for Web-based instruments with URL interface.
InstrumentConsole  
InstrumentDatasheet Definition of Instrument Datasheet @author Mike Risi
InstrumentPortInputStream  
InstrumentPortOutputStream InstrumentPortOutputStream enforces inter-byte delay when writing to the instrument
InstrumentSampler InstrumentSampler acquires samples from node instruments.
InstrumentService Deprecated. Replaced by BaseInstrumentService, PolledInstrumentService, and StreamingInstrumentService.
IoResourceType  
LogSampleServiceEvent LogSample Service Event
MeasurementLogger This FunctionBlock logs SiamRecords into MeasurementPackets.
MessageCache MessageCache contains a hashmap of message texts generated by an associated instrument service; each text has associated list of times at which the text occurred.
MiscDevicePort MiscDevicePort implements a miscellaneous DevicePort.
MiscInstrumentPort Implements InstrumentPort interface for a miscellaneous port.
NodeConfiguratorImpl NodeConfiguratorImpl implements the default NodeConfigurator, and encapsulates the default configuration of hardware-dependent components
NodeEvent Node Event super class from which all Node events are extended
NodeLinkCallback Notifies NodeService of shore link connect/disconnect.
NodeMain Create a NodeManager object.
NodeManager NodeManager implements node functionality, and instantiates component objects including NodeService, PortManager, etc.
NodeProperties NodeProperties is responsible for parsing the Node properties file (typically siamPort.cfg) in order to configure the Node.
NodeServer NodeServer is one half of an RMI replacement using Sockets.
NodeService NodeService implements the Node interface, and manages multiple Devices (including Instruments).
NodeSocketFactory Socket factory used on the node.
NullPowerPort Implementation of PowerPort interface; used when power control hardware is absent.
NullPuck  
NVTDevicePort NVTDevicePort extends SerialDevicePort for an RFC2217 compliant serial device.
NVTInstrumentPort Implements power control and communications to an instrument via ethernet-to-serial terminal server using RFC 2217.
PolledInstrumentService PolledInstrumentService represents an instrument that is synchronously polled for its data.
PortManager PortManager keeps track of devices installed on node ports.
PowerEvent Power Event
PowerManager PowerManager is a singleton object that manages the system power for the MOOS Mooring Controller.
PuckHeader Definition of puck header @author Mike Risi
PuckInputStream The PuckInputStream constructor needs an input and output stream to a device that supports the puck serial protocol.
PuckOutputStream The PuckOutputStream is used to store binary data on the pucks non volatile memory.
PuckSerialInstrumentPort Implements power control and communications to an instrument via serial port.
Queue  
RemoteSerialPortServer Base class for thread which implements remote control of serial port
Scheduler - Scheduler: provides application global view of schedules, supporting operations like showSchedule and getNextScheduledJob - ScheduleTaskImpl: an implementation of ScheduleTask, which encapsulates scheduling timing and control - ScheduleSpecifier: cron-like representation of schedules - Scheduler.ScheduleKey: an inner class of Scheduler, a unique ScheduleOwnerID used in some contexts to resolve ownership of ScheduleTasks (e.g., to differentiate between two ScheduleTasks with the same name, owned by objects of the same class).
SchedulerEvent Scheduler Event
ScheduleTask The ScheduleTask is a standalone job that may be scheduled, encapsulating both the represention and execution of the job.
ScheduleTaskImpl An implementation of the abstract ScheduleTask.
ScheduleTimerTask The ScheduleTimerTask is the SiamTimerTask managed by each ScheduleTask.
SensorsJMSPublisher SensorsJMSPacketPublisher is the interface from SIAM to the SENSORS project's prototype for CyberInfrastructure.
SequenceNumber SequenceNumber is an implementation of the SequenceGenerator interface used for generating packet sequence numbers.
SerialDevicePort SerialDevicePort implements DevicePort for a serial device.
SerialInstrumentPort Implements power control and communications to an instrument via serial port.
SerialPortParameters SerialPortParameters specifies baud, number of data bits, parity, and number of stop bits.
ServiceEvent Service Event
ServiceSandBox  
SiamClientSocketFactory  
SiamProperties SiamProperties extends java.util.Properties, with more robust parsing of keys and values.
SiamServerSocketFactory  
SiamTimer A facility for threads to schedule tasks for future execution in a background thread.
SiamTimerTask A task that can be scheduled for one-time or repeated execution by a Timer.
SleepManager SleepManager is a singleton object that manages the transition of the CPU into and out of sleep mode.
StatusReport Base class for objects which generate information about health and status of a node subsystem.
StreamingInstrumentService StreamingInstrumentService represents an instrument that "streams" data asynchronously to its serial port.
SubnodeListener SubnodeListener listens for contacts from subnodes, and maintains list of of subnodes.
TerminalInstrumentService The "instrument" is just a terminal emulator (e.g.
WDTManager WDTManager is a singleton object that manages initialization and strobing of the watchdog timer.
 

Exception Summary
PuckModeException PuckModeException indicates that the PuckSerialInstrumentPort was not in puck mode
 

Package org.mbari.siam.core Description

Components that execute on deployed at-sea processor when used on low-bandwidth-to-shore systems such as moorings; on cable-to-shore systems these components may actually execute on shore; includes the instrument service framework.



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.