Class Setup

Setup Command

Hierarchy

ParameterSetType<Setup>
- Setup

Implements

Command<typeof SetupL>

Index

Constructors

Properties

_type commandName maybeObsId paramSet source

Methods

add create exists get madd remove size

Constructors

constructor

new Setup(
    source: Prefix,
    commandName: string,
    paramSet?: Parameter<Key>[],
    maybeObsId?: Option<string>,
): Setup
A parameter set for setting telescope and instrument parameters.
Parameters
- source: Prefix
  prefix representing source of the command
- commandName: string
  the name of the command
- paramSet: Parameter<Key>[] = []
  an optional set of parameters
- maybeObsId: Option<string> = undefined
  an optional obsId for command
Returns Setup
a new instance of Setup
Overrides ParameterSetType<Setup>.constructor
- Defined in src/models/params/Command.ts:70

Properties

`Readonly`_type

_type: "Setup" = SetupL

`Readonly`commandName

commandName: string

the name of the command

`Readonly`maybeObsId

maybeObsId: Option<string> = undefined

an optional obsId for command

`Readonly`paramSet

paramSet: Parameter<Key>[] = []

an optional set of parameters

`Readonly`source

source: Prefix

prefix representing source of the command

Methods

add

add<P extends Parameter<Key>>(parameter: P): Setup
Adds a parameter to the parameter set
Type Parameters
- P extends Parameter<Key>
Parameters
- parameter: P
  the parameter to add
Returns Setup
a new instance of this parameter set with the given parameter added

Tparam
P the Parameter type
Inherited from ParameterSetType.add
- Defined in src/models/params/ParameterSetType.ts:38

create

create(data: Parameter<Key>[]): Setup
Create a new Setup instance when a parameter is added or removed
Parameters
- data: Parameter<Key>[]
  set of parameters
Returns Setup
a new instance of Setup with provided data
Overrides ParameterSetType.create
- Defined in src/models/params/Command.ts:85

exists

exists<S extends Key>(key: BaseKeyType<S>): boolean
Returns true if the key exists in the parameter set
Type Parameters
- S extends Key
Parameters
- key: BaseKeyType<S>
  the key to check for
Returns boolean
true if the key is found

Tparam
S the Key value
Inherited from ParameterSetType.exists
- Defined in src/models/params/ParameterSetType.ts:74

get

get<S extends Key>(key: BaseKeyType<S>): Option<Parameter<S>>
Returns an Option with the parameter for the key if found, otherwise undefined
Type Parameters
- S extends Key
Parameters
- key: BaseKeyType<S>
  the Key to be used for lookup
Returns Option<Parameter<S>>
the parameter for the key, if found

Tparam
S the value type
Inherited from ParameterSetType.get
- Defined in src/models/params/ParameterSetType.ts:61

madd

madd<P extends Parameter<Key>>(parametersToAdd: P[]): Setup
Adds several parameters to the parameter set
Type Parameters
- P extends Parameter<Key>
Parameters
- parametersToAdd: P[]
  the list of parameters to add to the parameter set
Returns Setup
a new instance of this parameter set with the given parameter added

Note
madd ensures check for duplicate key

Tparam
P must be a subclass of Parameter
Inherited from ParameterSetType.madd
- Defined in src/models/params/ParameterSetType.ts:50

remove

remove<S extends Key>(key: BaseKeyType<S>): Setup
Remove a parameter from the parameter set by key
Type Parameters
- S extends Key
Parameters
- key: BaseKeyType<S>
  the Key to be used for removal
Returns Setup
a new T, where T is a parameter set child with the key removed or identical if the key is not present

Tparam
S the Key value
Inherited from ParameterSetType.remove
- Defined in src/models/params/ParameterSetType.ts:85

size

size(): number
The number of parameters in this parameter set

Returns number
the number of parameters in the parameter set
Inherited from ParameterSetType.size
- Defined in src/models/params/ParameterSetType.ts:27