Package org.lsst.ccs

This package deals with core classes for subsystems.

See: Description

Interface Summary

Interface	Description
CCSProxy	A (probably Configurable object that acts on behalf of an object which is not directly handled as a Configurable.
InvocationListener	An Object that want to be warned when a command is going to be executed.

Class Summary

Class	Description
BusMaster	A bus master is a subsystem that can send write commands and acquire locks.
CCSCst	Constants to be shared by all codes.
CurrentCommandContext	Informations about the command being executed by the current Command Thread.
Subsystem	The base class for a CCS subsystem.
Subsystem.SignalThread	threads that run "signals" are peculiar because they know about a time deadline.
Subsystem.State	this class represents a composite state ofr a Subsystem.

Enum Summary

Enum	Description
AlarmState	State elements that deal with Alarms.
CommandState	State elements that deal with command execution context.
Mode	Expresses the context in which an action takes place
Phase	State elements dealing with subsystem lifecycle.

Exception Summary

Exception	Description
ActionCommandStillRunning	An ACTION command was invoked though another ACTION was still running.
AlarmNotClearedException	While trying to return the subsystem to normal mode it appears that alarms have not been cleared.
ClosingStateException	Commands were issued though the system was closing
HardwareException	base class ofr Hardware Exception.
InvocationVetoException	Fired by InvocationListeners to veto a command execution.
SignalsStillRunning	While trying to return to normal (ready) mode it appears that some ABORT (signal) command is still running.
SystemStateException	Base class for reporting subsystem state anomalies.

Package org.lsst.ccs Description

This package deals with core classes for subsystems.

The Subsystem class is the parent class for subsystems that operate on the buses:

• NodeModularSubsystem: this class is used for Modular ("worker") subsystems
• BusMaster: for "active" subsystems that invoke commands to be executed by other subsystems.

Subsystem's code uses codes defined in:

• the "buses" sub-project (in package org.lsst.ccs.bus (defines data to be used for exchange between subsystems)
• in the "command" sub-project (the structure of the data exchanged when dealing with commands)
• in "messaging-layer" definition (how to exchange data)
• in "utilities"

Subsystem has an inner class to define its state: Subsystem.State. This class combines different enums to define the state of the subsystem

• The Phase : describe the current phase of subsystem life (such as initialization, operational, closing,..)
• The Mode : expresses the context in which and action may take place (such as normal or engineering)
• The CommandState : (such as ready to accept any command or off)
• the AlarmState : (such as warning, alarm or none).

A subsystem provides also a CurrentCommandContext object that can be queried by codes running in the context of this subsystem and want to be aware of the context in which they are invoked.

The execution of command should be aware of instances of InvocationListener that may veto the execution of a command.

Other classes deal with standard Exceptions.

Author:

bamade