org.lsst.ccs.bus.states

Interface AgentState

All Known Implementing Classes:

AlertState, CommandState, ConfigurationState, OperationalState, PhaseState

public interface AgentState

Marker interface to distinguish internal states of an Agent. Classes implementing this interface should extend Enum. Static methods of this interface check constraints of the Agent state machine, as documented at https://confluence.slac.stanford.edu/display/LSSTCAM/State+Diagrams.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
static boolean	isLegal(StateBundle bundle) Returns true if Agent internal states in the specified bundle are consistent.
static boolean	isLegal(StateBundle before, StateBundle after) Returns true if the transition between Agent internal states specified by the two bundles is allowed.

Method Detail

isLegal

static boolean isLegal(StateBundle bundle)

Returns true if Agent internal states in the specified bundle are consistent.

Parameters:

bundle - state bundle to check

Returns:

false if Agent internal state in the specified bundle violates state machine constraints

isLegal

static boolean isLegal(StateBundle before,
                       StateBundle after)

Returns true if the transition between Agent internal states specified by the two bundles is allowed.

Parameters:

before - state before transition

after - state after transition

Returns:

false if the transition violates state machine constraints