org.lsst.ccs

Class Subsystem.State

java.lang.Object

org.lsst.ccs.Subsystem.State

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

Subsystem

public static class Subsystem.State
extends Object
implements Serializable, Cloneable

this class represents a composite state ofr a Subsystem. each member represents a different aspect of state.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
State() when created an initial state is: mode = ENGINEERING_OK (when commands will be available they will operate in Engineering mode ...

Method Summary

Modifier and Type	Method and Description
Subsystem.State	clone()
boolean	equals(Object o)
AlarmState	getAlarmState()
CommandState	getCommandProcessing()
Mode	getMode()
Phase	getPhase() (duplication of getProcessingState ..
Phase	getProcessingState()
String	getStateExtraInfo() gets additional comments that may be published with the overall state
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

State

public State()

when created an initial state is:

• mode = ENGINEERING_OK (when commands will be available they will operate in Engineering mode ... htis will change when initialisation completes sucessfully)
• phase= INTIAILIZING
• commandProcessing = OFF (this will change when command will be enbled)
• alarm state = NOMINAL (nothing special .... yet)

Method Detail

getProcessingState

public Phase getProcessingState()

Returns:

the current phase (such as INITIALIZING or OPERATIONAL)

See Also:

Phase

getMode

public Mode getMode()

Returns:

the current mode (such as ENGINEERING_FAULT or NORMAL)

See Also:

Mode

getAlarmState

public AlarmState getAlarmState()

Returns:

the current alarm state (such as NOMINAL or WARNING)

See Also:

AlarmState

getPhase

public Phase getPhase()

(duplication of getProcessingState .. but that may change)

Returns:

the current phase (such as INITIALIZING or OPERATIONAL)

See Also:

Phase

getCommandProcessing

public CommandState getCommandProcessing()

Returns:

the current command execution state (such as READY or ACTIVE)

See Also:

CommandState

getStateExtraInfo

public String getStateExtraInfo()

gets additional comments that may be published with the overall state

Returns:

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Subsystem.State clone()

Overrides:

clone in class Object