Package csw.params.core.states
Interface StateVariable
-
- All Superinterfaces:
CommandSerializable
- All Known Implementing Classes:
CurrentState,DemandState
public interface StateVariable extends CommandSerializable
Base trait for state variables
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description scala.collection.immutable.Set<Parameter<?>>paramSet()an optional initial set of items (keys with values)Prefixprefix()identifies the target subsystemStateNamestateName()identifies the name of the statejava.lang.StringtoString()A common toString method for all concrete implementationjava.lang.StringtypeName()A name identifying the type of command, such as "setup", "observe".
-
-
-
Method Detail
-
prefix
Prefix prefix()
identifies the target subsystem- Returns:
- (undocumented)
-
paramSet
scala.collection.immutable.Set<Parameter<?>> paramSet()
an optional initial set of items (keys with values)- Returns:
- (undocumented)
-
stateName
StateName stateName()
identifies the name of the state- Returns:
- (undocumented)
-
typeName
java.lang.String typeName()
A name identifying the type of command, such as "setup", "observe". This is used in the JSON and toString output.- Returns:
- (undocumented)
-
toString
java.lang.String toString()
A common toString method for all concrete implementation- Overrides:
toStringin classjava.lang.Object- Returns:
- the string representation of command
-
-