Package csw.params.commands
Class Observe
- java.lang.Object
-
- csw.params.core.generics.ParameterSetType<Observe>
-
- csw.params.commands.Observe
-
- All Implemented Interfaces:
Command
,ControlCommand
,SequenceCommand
,java.io.Serializable
,scala.Equals
,scala.Product
public class Observe extends ParameterSetType<Observe> implements ControlCommand, scala.Product, java.io.Serializable
A parameter set for setting telescope and instrument parameters.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Observe(Prefix source, CommandName commandName, java.util.Optional<ObsId> maybeObsId)
A java helper to construct Observe commandObserve(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Observe
apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId)
The apply method is used to create Observe command by end-user.static Observe
apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)
The apply method is used to create Observe command by end-user.CommandName
commandName()
The name of commandprotected Observe
create(scala.collection.immutable.Set<Parameter<?>> data)
Create a new Observe instance when a parameter is added or removedscala.Option<ObsId>
maybeObsId()
An optional obsId for commandscala.collection.immutable.Set<Parameter<?>>
paramSet()
Holds the parameters for this parameter setPrefix
source()
Prefix representing source of the command-
Methods inherited from class csw.params.core.generics.ParameterSetType
add, apply, contains, dataToString, exists, find, get, get, getStringMap, jFind, jGet, jGet, jGetStringMap, jMadd, jMissingKeys, jMissingKeys, jParamSet, madd, madd, madd, missingKeys, parameter, remove, remove, size, toString, typeName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface csw.params.commands.Command
jMaybeObsId, paramType, toString, typeName
-
-
-
-
Constructor Detail
-
Observe
public Observe(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)
-
Observe
public Observe(Prefix source, CommandName commandName, java.util.Optional<ObsId> maybeObsId)
A java helper to construct Observe command- Parameters:
source
- (undocumented)commandName
- (undocumented)maybeObsId
- (undocumented)
-
-
Method Detail
-
apply
public static Observe apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId)
The apply method is used to create Observe command by end-user.- Parameters:
source
- prefix representing source of the commandcommandName
- the name of the commandmaybeObsId
- an optional obsId for command- Returns:
- a new instance of Observe with empty paramSet
-
apply
public static Observe apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)
The apply method is used to create Observe command by end-user.- Parameters:
source
- prefix representing source of the commandcommandName
- the name of the commandmaybeObsId
- an optional obsId for commandparamSet
- an initial set of parameters (keys with values)- Returns:
- a new instance of Observe
-
source
public Prefix source()
Description copied from interface:Command
Prefix representing source of the command
-
commandName
public CommandName commandName()
Description copied from interface:Command
The name of command- Specified by:
commandName
in interfaceCommand
- Returns:
- (undocumented)
-
maybeObsId
public scala.Option<ObsId> maybeObsId()
Description copied from interface:Command
An optional obsId for command- Specified by:
maybeObsId
in interfaceCommand
- Returns:
- (undocumented)
-
paramSet
public scala.collection.immutable.Set<Parameter<?>> paramSet()
Description copied from class:ParameterSetType
Holds the parameters for this parameter set- Specified by:
paramSet
in interfaceCommand
- Specified by:
paramSet
in classParameterSetType<Observe>
- Returns:
- (undocumented)
-
create
protected Observe create(scala.collection.immutable.Set<Parameter<?>> data)
Create a new Observe instance when a parameter is added or removed- Specified by:
create
in classParameterSetType<Observe>
- Parameters:
data
- set of parameters- Returns:
- a new instance of Observe with new provided data
-
-