Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Prefix

A top level key for a parameter set: combination of subsystem and the subsystem's prefix e.g. tcs.filter.wheel, wfos.prog.cloudcover, etc

Hierarchy

  • Prefix

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Prefix(subsystem: "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", componentName: string): Prefix
  • note

    Component name should not contain

    • leading or trailing spaces
    • and hyphen (-)

    Parameters

    • subsystem: "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"

      component subsystem - tcs (TCS), wfos (WFOS)

    • componentName: string

      component name - filter.wheel, prog.cloudcover

    Returns Prefix

Properties

Readonly componentName

componentName: string

Readonly subsystem

subsystem: "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"

Methods

toJSON

  • toJSON(): string

Static fromString

  • fromString(prefixStr: string): Prefix

  • Creates a Prefix based on the given value of format tcs.filter.wheel and splits it to have tcs as subsystem and filter.wheel as componentName

    Parameters

    • prefixStr: string

      of format tcs.filter.wheel

    Returns Prefix

    a Prefix instance

Generated using TypeDoc