Class Setup

Setup Command

Hierarchy

ParameterSetType<Setup>
- Setup

Implements

Command<typeof SetupL>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Setup(source: Prefix, commandName: string, paramSet?: Parameter<Key>[], maybeObsId?: Option<string>): Setup

Overrides ParameterSetType<Setup>.constructor
- Defined in src/models/params/Command.ts:65
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> = ...
  
  an optional obsId for command
Returns Setup

a new instance of Setup

Properties

Readonly _type

_type: "Setup" = ...

Readonly commandName

commandName: string

Readonly maybeObsId

maybeObsId: Option<string> = ...

Readonly paramSet

paramSet: Parameter<Key>[] = []

Readonly source

source: Prefix

Methods

add

add<P>(parameter: P): Setup

Inherited from ParameterSetType.add
- Defined in src/models/params/ParameterSetType.ts:33
Adds a parameter to the parameter set

tparam

P the Parameter type

Type parameters
- P: Parameter<Key, P>
Parameters
- parameter: P
  
  the parameter to add
Returns Setup

a new instance of this parameter set with the given parameter added

create

create(data: Parameter<Key>[]): Setup

Overrides ParameterSetType.create
- Defined in src/models/params/Command.ts:80
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

exists

exists<S>(key: BaseKeyType<S>): boolean

Inherited from ParameterSetType.exists
- Defined in src/models/params/ParameterSetType.ts:69
Returns true if the key exists in the parameter set

tparam

S the Key value

Type parameters
- S: Key
Parameters
- key: BaseKeyType<S>
  
  the key to check for
Returns boolean

true if the key is found

get

get<S>(key: BaseKeyType<S>): Option<Parameter<S>>

Inherited from ParameterSetType.get
- Defined in src/models/params/ParameterSetType.ts:56
Returns an Option with the parameter for the key if found, otherwise undefined

tparam

S the value type

Type parameters
- S: Key
Parameters
- key: BaseKeyType<S>
  
  the Key to be used for lookup
Returns Option<Parameter<S>>

the parameter for the key, if found

madd

madd<P>(parametersToAdd: P[]): Setup

Inherited from ParameterSetType.madd
- Defined in src/models/params/ParameterSetType.ts:45
Adds several parameters to the parameter set

note

madd ensures check for duplicate key

tparam

P must be a subclass of Parameter

Type parameters
- P: Parameter<Key, P>
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

remove

remove<S>(key: BaseKeyType<S>): Setup

Inherited from ParameterSetType.remove
- Defined in src/models/params/ParameterSetType.ts:80
Remove a parameter from the parameter set by key

tparam

S the Key value

Type parameters
- S: 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

size

size(): number

Inherited from ParameterSetType.size
- Defined in src/models/params/ParameterSetType.ts:22
The number of parameters in this parameter set

Returns number

the number of parameters in the parameter set

Generated using TypeDoc