Class Observe

Observe Command

Hierarchy

ParameterSetType<Observe>
- Observe

Implements

Command<typeof ObserveL>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides ParameterSetType<Observe>.constructor
- Defined in src/models/params/Command.ts:107
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 Observe
a new instance of Observe

Properties

Readonly _type

_type: "Observe" = ObserveL

Readonly commandName

commandName: string

Readonly maybeObsId

maybeObsId: Option<string> = undefined

Readonly paramSet

paramSet: Parameter<Key>[] = []

Readonly source

source: Prefix

Methods

add

add<P>(parameter: P): Observe

Inherited from ParameterSetType.add
- Defined in src/models/params/ParameterSetType.ts:38
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 Observe
a new instance of this parameter set with the given parameter added

create

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

Overrides ParameterSetType.create
- Defined in src/models/params/Command.ts:122
Create a new Observe instance when a parameter is added or removed

Parameters
- data: Parameter<Key>[]
  
  set of parameters
Returns Observe
a new instance of Observe with provided data

exists

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

Inherited from ParameterSetType.exists
- Defined in src/models/params/ParameterSetType.ts:74
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:61
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[]): Observe

Inherited from ParameterSetType.madd
- Defined in src/models/params/ParameterSetType.ts:50
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 Observe
a new instance of this parameter set with the given parameter added

remove

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

Inherited from ParameterSetType.remove
- Defined in src/models/params/ParameterSetType.ts:85
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 Observe
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:27
The number of parameters in this parameter set

Returns number
the number of parameters in the parameter set

Generated using TypeDoc