Options
All
  • Public
  • Public/Protected
  • All
Menu

Module models

Index

Namespaces

Classes Common

Classes Other

Classes Params

Interfaces Other

Interfaces Params

Type aliases Common

Type aliases Sequencer Service

Type aliases Command Service

Type aliases Other

Type aliases Params

Variables

Functions

Common Type aliases

ComponentType

ComponentType: "HCD" | "Assembly" | "Service" | "Container" | "Sequencer" | "SequenceComponent" | "Machine"

Represents a type of the Component.

ContainerLifecycleState

ContainerLifecycleState: "Idle" | "Running"

Lifecycle state of a container actor

SupervisorLifecycleState

SupervisorLifecycleState: "Idle" | "Running" | "RunningOffline" | "Restart" | "Shutdown" | "Lock"

Lifecycle state of a Supervisor actor

Sequencer Service Type aliases

SequenceCommand

SequenceCommand: Setup | Observe | Wait

Marker type for sequence parameter sets which is applicable to Sequencer type of components

Command Service Type aliases

CommandResponse

CommandResponse: Error | Invalid | Locked | Started | Completed | Cancelled | Accepted

ControlCommand

ControlCommand: Setup | Observe

Marker type for control parameter sets which is applicable to Assembly and HCD type of components

OnewayResponse

OnewayResponse: Accepted | Invalid | Locked

SubmitResponse

SubmitResponse: Error | Invalid | Locked | Started | Completed | Cancelled

ValidateResponse

ValidateResponse: Accepted | Invalid | Locked

Other Type aliases

Accepted

Accepted: { _type: "Accepted"; runId: string }

Type declaration

  • _type: "Accepted"
  • runId: string

AppConfig

AppConfig: { applicationName: string }

Type declaration

  • applicationName: string

AppConfigModule

AppConfigModule: { AppConfig: AppConfig }

Shape for Application config module

Type declaration

AuthData

AuthData: { tokenFactory?: TokenFactory; username?: string }

Type declaration

  • Optional tokenFactory?: TokenFactory

    a function that returns a valid auth token which has correct access roles and permissions

  • Optional username?: string

    username of the logged in user

BaseKeyType

BaseKeyType<K>: BaseKey<K> | ChoiceKeyFactory<K, any>

Type parameters

Cancelled

Cancelled: { _type: "Cancelled"; runId: string }

Type declaration

  • _type: "Cancelled"
  • runId: string

CommandIssue

CommandIssue: { _type: IssueTypes; reason: string }

Type declaration

Completed

Completed: { _type: "Completed"; result: Result; runId: string }

Type declaration

  • _type: "Completed"
  • result: Result
  • runId: string

Done

Done: "Done"

EqFrame

EqFrame: "ICRS" | "FK5"

Error

Error: { _type: "Error"; message: string; runId: string }

Type declaration

  • _type: "Error"
  • message: string
  • runId: string

Failed

Failed: { _type: "Failed"; msg: string }

Type declaration

  • _type: "Failed"
  • msg: string

Invalid

Invalid: { _type: "Invalid"; issue: CommandIssue; runId: string }

Type declaration

IssueTypes

IssueTypes: "AssemblyBusyIssue" | "HCDBusyIssue" | "IdNotAvailableIssue" | "MissingKeyIssue" | "OtherIssue" | "ParameterValueOutOfRangeIssue" | "RequiredAssemblyUnavailableIssue" | "RequiredHCDUnavailableIssue" | "RequiredSequencerUnavailableIssue" | "RequiredServiceUnavailableIssue" | "UnresolvedLocationsIssue" | "UnsupportedCommandInStateIssue" | "UnsupportedCommandIssue" | "WrongInternalStateIssue" | "WrongNumberOfParametersIssue" | "WrongParameterTypeIssue" | "WrongPrefixIssue" | "WrongUnitsIssue" | "WrongCommandTypeIssue"

LocationServiceError

LocationServiceError: { _type: "LocationServiceError"; reason: string }

Type declaration

  • _type: "LocationServiceError"
  • reason: string

Locked

Locked: { _type: "Locked"; runId: string }

Type declaration

  • _type: "Locked"
  • runId: string

Option

Option<T>: T | undefined

Type parameters

  • T

ProperMotion

ProperMotion: { pmx: number; pmy: number }

Type declaration

  • pmx: number
  • pmy: number

SolarSystemObject

SolarSystemObject: "Mercury" | "Venus" | "Moon" | "Mars" | "Jupiter" | "Saturn" | "Neptune" | "Uranus" | "Pluto"

Started

Started: { _type: "Started"; runId: string }

Type declaration

  • _type: "Started"
  • runId: string

TokenFactory

TokenFactory: () => string | undefined

Type declaration

    • (): string | undefined

    • A function which returns valid auth token

      function

      Returns string | undefined

Unhandled

Unhandled: { _type: "Unhandled"; messageType: string; msg: string; state: string }

Type declaration

  • _type: "Unhandled"
  • messageType: string
  • msg: string
  • state: string

Params Type aliases

Coord

Coord: EqCoord | MinorPlanetCoord | SolarSystemCoord | CometCoord | AltAzCoord

All coordinates are a Coord. i.e CometCoord, AltAzCoord, SolarSystemCoord, MinorPlanetCoord & EqCoord

Key

Key: IntKey | LongKey | ShortKey | FloatKey | DoubleKey | ByteKey | StringKey | CharKey | ChoiceKey | IntMatrixKey | ByteMatrixKey | LongMatrixKey | ShortMatrixKey | FloatMatrixKey | DoubleMatrixKey | IntArrayKey | ByteArrayKey | LongArrayKey | ShortArrayKey | FloatArrayKey | DoubleArrayKey | BooleanKey | UTCTimeKey | TAITimeKey | EqCoordKey | SolarSystemCoordKey | MinorPlanetCoordKey | CometCoordKey | AltAzCoordKey | CoordKey

Keys defined for consumption in Typescript code

Subsystem

Subsystem: typeof subsystems[number]

A union type representing TMT Subsystems

Variables

subsystems

subsystems: readonly ["AOESW", "APS", "CIS", "CLN", "CRYO", "CSW", "DMS", "DPS", "ENC", "ESEN", "ESW", "HNDL", "HQ", "IRIS", "LGSF", "M1COAT", "M1CS", "M1S", "M2COAT", "M2S", "M3S", "MODHIS", "NFIRAOS", "OSS", "REFR", "SCMS", "SER", "SOSS", "STR", "SUM", "TCS", "TINS", "WFOS", "Container"] = ...

Functions

Const altAzCoordKey

  • altAzCoordKey(name: string, units?: Units): BaseKey<AltAzCoordKey>

Const booleanKey

  • booleanKey(name: string, units?: Units): BaseKey<BooleanKey>

Const byteArrayKey

  • byteArrayKey(name: string, units?: Units): BaseKey<ByteArrayKey>

  • A KeyType that has suffix *-ArrayKey holds Arrays Helper functions to create Array parameters

    Parameters

    • name: string
    • Optional units: Units

    Returns BaseKey<ByteArrayKey>

Const byteKey

  • byteKey(name: string, units?: Units): BaseKey<ByteKey>

Const byteMatrixKey

  • byteMatrixKey(name: string, units?: Units): BaseKey<ByteMatrixKey>

  • A KeyType that has suffix *-MatrixKey holds Matrices Helper functions to create Matrix parameters

    Parameters

    • name: string
    • Optional units: Units

    Returns BaseKey<ByteMatrixKey>

Const charKey

  • charKey(name: string, units?: Units): BaseKey<CharKey>

Const choiceKey

  • choiceKey<L>(name: string, choices: readonly L[], units?: Units): ChoiceKeyFactory<ChoiceKey<L>, readonly L[]>

  • A KeyType that holds Choices

    tparam

    L type for choices

    Type parameters

    • L: string

    Parameters

    • name: string

      a strig for the choice key

    • choices: readonly L[]

      list of options to be made available for the choice key

    • units: Units = Units.NoUnits

      the units for the key

    Returns ChoiceKeyFactory<ChoiceKey<L>, readonly L[]>

    an instance of ChoiceKey for the given name, choices and units

Const cometCoordKey

  • cometCoordKey(name: string, units?: Units): BaseKey<CometCoordKey>

Const coordKey

  • coordKey(name: string, units?: Units): BaseKey<CoordKey>

Const doubleArrayKey

  • doubleArrayKey(name: string, units?: Units): BaseKey<DoubleArrayKey>

Const doubleKey

  • doubleKey(name: string, units?: Units): BaseKey<DoubleKey>

Const doubleMatrixKey

  • doubleMatrixKey(name: string, units?: Units): BaseKey<DoubleMatrixKey>

Const download

Const eqCoordKey

  • eqCoordKey(name: string, units?: Units): BaseKey<EqCoordKey>

Const floatArrayKey

  • floatArrayKey(name: string, units?: Units): BaseKey<FloatArrayKey>

Const floatKey

  • floatKey(name: string, units?: Units): BaseKey<FloatKey>

Const floatMatrixKey

  • floatMatrixKey(name: string, units?: Units): BaseKey<FloatMatrixKey>

Const intArrayKey

  • intArrayKey(name: string, units?: Units): BaseKey<IntArrayKey>

Const intKey

  • intKey(name: string, units?: Units): BaseKey<IntKey>

Const intMatrixKey

  • intMatrixKey(name: string, units?: Units): BaseKey<IntMatrixKey>

Const longArrayKey

  • longArrayKey(name: string, units?: Units): BaseKey<LongArrayKey>

Const longKey

  • longKey(name: string, units?: Units): BaseKey<LongKey>

Const longMatrixKey

  • longMatrixKey(name: string, units?: Units): BaseKey<LongMatrixKey>

Const minorPlanetCoordKey

  • minorPlanetCoordKey(name: string, units?: Units): BaseKey<MinorPlanetCoordKey>

Const shortArrayKey

  • shortArrayKey(name: string, units?: Units): BaseKey<ShortArrayKey>

Const shortKey

  • shortKey(name: string, units?: Units): BaseKey<ShortKey>

Const shortMatrixKey

  • shortMatrixKey(name: string, units?: Units): BaseKey<ShortMatrixKey>

Const solarSystemCoordKey

  • solarSystemCoordKey(name: string, units?: Units): BaseKey<SolarSystemCoordKey>

Const stringKey

  • stringKey(name: string, units?: Units): BaseKey<StringKey>

Const taiTimeKey

  • taiTimeKey(name: string, units?: Units): BaseKey<TAITimeKey>

Const utcTimeKey

  • utcTimeKey(name: string, units?: Units): BaseKey<UTCTimeKey>

Generated using TypeDoc