Package csw.params.commands
Interface Command
-
- All Known Subinterfaces:
ControlCommand,SequenceCommand
public interface CommandCommon trait representing commands in TMT like Setup, Observe and Wait
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CommandNamecommandName()The name of commandjava.util.Optional<ObsId>jMaybeObsId()A Java helper to acsess optional obsIdscala.Option<ObsId>maybeObsId()An optional obsId for commandscala.collection.immutable.Set<Parameter<?>>paramSet()An optional initial set of parameters (keys with values)ParameterSetType<?>paramType()A helper to give access of public members of ParameterSetTypeIdrunId()unique Id for command parameter setPrefixsource()Prefix representing source of the commandjava.lang.StringtoString()A common toString method for all concrete implementationjava.lang.StringtypeName()A name identifying the type of parameter set, such as "setup", "observe".
-
-
-
Method Detail
-
commandName
CommandName commandName()
The name of command- Returns:
- (undocumented)
-
jMaybeObsId
java.util.Optional<ObsId> jMaybeObsId()
A Java helper to acsess optional obsId- Returns:
- an Optional of ObsId
-
maybeObsId
scala.Option<ObsId> maybeObsId()
An optional obsId for command- Returns:
- (undocumented)
-
paramSet
scala.collection.immutable.Set<Parameter<?>> paramSet()
An optional initial set of parameters (keys with values)- Returns:
- (undocumented)
-
paramType
ParameterSetType<?> paramType()
A helper to give access of public members of ParameterSetType- Returns:
- a handle to ParameterSetType extended by concrete implementation of this class
-
runId
Id runId()
unique Id for command parameter set- Returns:
- (undocumented)
-
source
Prefix source()
Prefix representing source of the command- 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
-
typeName
java.lang.String typeName()
A name identifying the type of parameter set, such as "setup", "observe". This is used in toString output and while de-serializing from JSON.- Returns:
- a string representation of concrete type of this class
-
-