Package csw.params.commands

Class Setup

java.lang.Object

csw.params.core.generics.ParameterSetType<Setup>

csw.params.commands.Setup

All Implemented Interfaces:

Command, ControlCommand, SequenceCommand, java.io.Serializable, scala.Equals, scala.Product

public class Setup
extends ParameterSetType<Setup>
implements ControlCommand, scala.Product, java.io.Serializable

A parameter set for setting telescope and instrument parameters. Constructor is private to ensure RunId is created internally to guarantee unique value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Setup(Id runId, Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)
Setup(Prefix source, CommandName commandName, java.util.Optional<ObsId> maybeObsId)	A java helper to construct Setup command

Method Summary

Modifier and Type	Method	Description
static Setup	apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId)	The apply method is used to create Setup command by end-user.
static Setup	apply(Prefix source, CommandName commandName, scala.Option<ObsId> maybeObsId, scala.collection.immutable.Set<Parameter<?>> paramSet)	The apply method is used to create Setup command by end-user.
Setup	cloneCommand()	Create a new Setup instance from an existing instance
CommandName	commandName()	The name of command
protected Setup	create(scala.collection.immutable.Set<Parameter<?>> data)	Create a new Setup instance when a parameter is added or removed
scala.Option<ObsId>	maybeObsId()	An optional obsId for command
scala.collection.immutable.Set<Parameter<?>>	paramSet()	Holds the parameters for this parameter set
Id	runId()	unique Id for command parameter set
Prefix	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, 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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Detail

Setup

public Setup(Id runId,
             Prefix source,
             CommandName commandName,
             scala.Option<ObsId> maybeObsId,
             scala.collection.immutable.Set<Parameter<?>> paramSet)

Setup

public Setup(Prefix source,
             CommandName commandName,
             java.util.Optional<ObsId> maybeObsId)

A java helper to construct Setup command

Parameters:

source - (undocumented)

commandName - (undocumented)

maybeObsId - (undocumented)

Method Detail

apply

public static Setup apply(Prefix source,
                          CommandName commandName,
                          scala.Option<ObsId> maybeObsId)

The apply method is used to create Setup command by end-user. runId is not accepted and will be created internally to guarantee unique value.

Parameters:

source - prefix representing source of the command

commandName - the name of the command

maybeObsId - an optional obsId for command

Returns:

a new instance of Setup with auto-generated runId and empty paramSet

apply

public static Setup apply(Prefix source,
                          CommandName commandName,
                          scala.Option<ObsId> maybeObsId,
                          scala.collection.immutable.Set<Parameter<?>> paramSet)

The apply method is used to create Setup command by end-user. runId is not accepted and will be created internally to guarantee unique value.

Parameters:

source - prefix representing source of the command

commandName - the name of the command

maybeObsId - an optional obsId for command

paramSet - an initial set of parameters (keys with values)

Returns:

a new instance of Setup with auto-generated runId

runId

public Id runId()

Description copied from interface: Command

unique Id for command parameter set

Specified by:

runId in interface Command

Returns:

(undocumented)

source

public Prefix source()

Description copied from interface: Command

Prefix representing source of the command

Specified by:

source in interface Command

Returns:

(undocumented)

commandName

public CommandName commandName()

Description copied from interface: Command

The name of command

Specified by:

commandName in interface Command

Returns:

(undocumented)

maybeObsId

public scala.Option<ObsId> maybeObsId()

Description copied from interface: Command

An optional obsId for command

Specified by:

maybeObsId in interface Command

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 interface Command

Specified by:

paramSet in class ParameterSetType<Setup>

Returns:

(undocumented)

create

protected Setup create(scala.collection.immutable.Set<Parameter<?>> data)

Create a new Setup instance when a parameter is added or removed

Specified by:

create in class ParameterSetType<Setup>

Parameters:

data - set of parameters

Returns:

a new instance of Setup with new runId and provided data

cloneCommand

public Setup cloneCommand()

Create a new Setup instance from an existing instance

Returns:

a new instance of Setup with new runId and copied data