Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Wait

Wait Command

Hierarchy

  • ParameterSetType<Wait>
    • Wait

Implements

  • Command<typeof WaitL>

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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 Wait

    a new instance of Wait

Properties

Readonly _type

_type: "Wait" = WaitL

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): Wait

  • Adds a parameter to the parameter set

    tparam

    P the Parameter type

    Type parameters

    Parameters

    • parameter: P

      the parameter to add

    Returns Wait

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

create

  • Create a new Wait instance when a parameter is added or removed

    Parameters

    Returns Wait

    a new instance of Wait with provided data

exists

  • Returns true if the key exists in the parameter set

    tparam

    S the Key value

    Type parameters

    Parameters

    Returns boolean

    true if the key is found

get

madd

  • madd<P>(parametersToAdd: P[]): Wait

  • Adds several parameters to the parameter set

    note

    madd ensures check for duplicate key

    tparam

    P must be a subclass of Parameter

    Type parameters

    Parameters

    • parametersToAdd: P[]

      the list of parameters to add to the parameter set

    Returns Wait

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

remove

  • Remove a parameter from the parameter set by key

    tparam

    S the Key value

    Type parameters

    Parameters

    Returns Wait

    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

Generated using TypeDoc