SequenceManagerService | @tmtsoftware/esw-ts

Hierarchy

SequenceManagerService

Index

Methods

configure

configure(obsMode: ObsMode): Promise<ConfigureResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:37
For given observation mode, if all the required resources are available, this API will start all the required sequencers.

Parameters
- obsMode: ObsMode
  
  Name of observation mode.
Returns Promise<ConfigureResponse>
ConfigureResponse as Promise.

getObsModesDetails

getObsModesDetails(): Promise<ObsModesDetailsResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:53
Returns all observing modes with their status, resources and sequencers

Returns Promise<ObsModesDetailsResponse>
ObsModesDetailsResponse.

getResources

getResources(): Promise<ResourcesStatusResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:131
gives status of all resources. It provides status of each resource (Available , InUse) and obsMode if the resource is in use.

Returns Promise<ResourcesStatusResponse>
ResourcesStatusResponse as Promise.

provision

provision(config: ProvisionConfig): Promise<ProvisionResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:46
shutdown all the running sequence components and provisions the new one in accordance with the provided config.

Parameters
- config: ProvisionConfig
  
  ProvisionConfig containing list of AgentProvisionConfig.
Returns Promise<ProvisionResponse>
ProvisionResponse as Promise.

restartSequencer

restartSequencer(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", obsMode: ObsMode, variation?: Variation): Promise<RestartSequencerResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:74
re-start the existing running sequencer for given subsystem and observing mode.

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"
  
  The subsystem of the sequencer to be started.
- obsMode: ObsMode
  
  The obsMode of the sequencer to be started.
- Optional variation: Variation
  
  The optional variation part of the sequencer to be started.
Returns Promise<RestartSequencerResponse>
RestartSequencerResponse as Promise.

shutdownAllSequenceComponents

shutdownAllSequenceComponents(): Promise<ShutdownSequenceComponentResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:122
shutdowns all the running sequence components.

Returns Promise<ShutdownSequenceComponentResponse>
ShutdownSequenceComponentResponse as Promise.

shutdownAllSequencers

shutdownAllSequencers(): Promise<ShutdownSequencersResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:107
shutdowns all the running sequencers.

Returns Promise<ShutdownSequencersResponse>
ShutdownSequencersResponse as Promise.

shutdownObsModeSequencers

shutdownObsModeSequencers(obsMode: ObsMode): Promise<ShutdownSequencersResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:100
shutdowns all the running sequencers found for given observation mode.

Parameters
- obsMode: ObsMode
  
  The observation mode.
Returns Promise<ShutdownSequencersResponse>
ShutdownSequencersResponse as Promise.

shutdownSequenceComponent

shutdownSequenceComponent(prefix: Prefix): Promise<ShutdownSequenceComponentResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:115
shutdowns running sequence component of given prefix.

Parameters
- prefix: Prefix
  
  The prefix of the sequence component
Returns Promise<ShutdownSequenceComponentResponse>
ShutdownSequenceComponentResponse as Promise.

shutdownSequencer

shutdownSequencer(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", obsMode: ObsMode, variation?: Variation): Promise<ShutdownSequencersResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:84
shutdowns the running sequencer found for given subsystem and observing mode.

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"
  
  The subsystem of the sequencer to be started.
- obsMode: ObsMode
  
  The obsMode of the sequencer to be started.
- Optional variation: Variation
  
  The optional variation part of the sequencer to be started.
Returns Promise<ShutdownSequencersResponse>
ShutdownSequencersResponse as Promise.

shutdownSubsystemSequencers

shutdownSubsystemSequencers(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"): Promise<ShutdownSequencersResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:92
shutdowns all the running sequencers found for given subsystem.

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"
  
  The subsystem.
Returns Promise<ShutdownSequencersResponse>
ShutdownSequencersResponse as Promise.

startSequencer

startSequencer(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", obsMode: ObsMode, variation?: Variation): Promise<StartSequencerResponse>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:64
starts a sequencer for given subsystem and observing mode. It starts a sequencer on an available sequence component for given subsystem.

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"
  
  The subsystem of the sequencer to be started.
- obsMode: ObsMode
  
  The obsMode of the sequencer to be started.
- Optional variation: Variation
  
  The optional variation part of the sequencer to be started.
Returns Promise<StartSequencerResponse>
StartSequencerResponse as Promise.

Hierarchy

Index

Methods

Methods

configure

Parameters

obsMode: ObsMode

Returns Promise<ConfigureResponse>

getObsModesDetails

Returns Promise<ObsModesDetailsResponse>

getResources

Returns Promise<ResourcesStatusResponse>

provision

Parameters

config: ProvisionConfig

Returns Promise<ProvisionResponse>

restartSequencer

Parameters

obsMode: ObsMode

Optional variation: Variation

Returns Promise<RestartSequencerResponse>

shutdownAllSequenceComponents

Returns Promise<ShutdownSequenceComponentResponse>

shutdownAllSequencers

Returns Promise<ShutdownSequencersResponse>

shutdownObsModeSequencers

Parameters

obsMode: ObsMode

Returns Promise<ShutdownSequencersResponse>

shutdownSequenceComponent

Parameters

prefix: Prefix

Returns Promise<ShutdownSequenceComponentResponse>

shutdownSequencer

Parameters

obsMode: ObsMode

Optional variation: Variation

Returns Promise<ShutdownSequencersResponse>

shutdownSubsystemSequencers

Parameters

Returns Promise<ShutdownSequencersResponse>

startSequencer

Parameters

obsMode: ObsMode

Optional variation: Variation

Returns Promise<StartSequencerResponse>