Interface SequenceManagerService

interface SequenceManagerService {
    configure(obsMode: ObsMode): Promise<ConfigureResponse>;
    getObsModesDetails(): Promise<ObsModesDetailsResponse>;
    getResources(): Promise<ResourcesStatusResponse>;
    provision(config: ProvisionConfig): Promise<ProvisionResponse>;
    restartSequencer(
        subsystem:
            | "Container"
            | "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",
        obsMode: ObsMode,
        variation?: Variation,
    ): Promise<RestartSequencerResponse>;
    shutdownAllSequenceComponents(): Promise<ShutdownSequenceComponentResponse>;
    shutdownAllSequencers(): Promise<ShutdownSequencersResponse>;
    shutdownObsModeSequencers(
        obsMode: ObsMode,
    ): Promise<ShutdownSequencersResponse>;
    shutdownSequenceComponent(
        prefix: Prefix,
    ): Promise<ShutdownSequenceComponentResponse>;
    shutdownSequencer(
        subsystem:
            | "Container"
            | "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",
        obsMode: ObsMode,
        variation?: Variation,
    ): Promise<ShutdownSequencersResponse>;
    shutdownSubsystemSequencers(
        subsystem:
            | "Container"
            | "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",
    ): Promise<ShutdownSequencersResponse>;
    startSequencer(
        subsystem:
            | "Container"
            | "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",
        obsMode: ObsMode,
        variation?: Variation,
    ): Promise<StartSequencerResponse>;
}

Methods

  • re-start the existing running sequencer for given subsystem and observing mode.

    Parameters

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

      The subsystem of the sequencer to be started.

    • obsMode: ObsMode

      The obsMode of the sequencer to be started.

    • Optionalvariation: Variation

      The optional variation part of the sequencer to be started.

    Returns Promise<RestartSequencerResponse>

    RestartSequencerResponse as Promise.

  • shutdowns the running sequencer found for given subsystem and observing mode.

    Parameters

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

      The subsystem of the sequencer to be started.

    • obsMode: ObsMode

      The obsMode of the sequencer to be started.

    • Optionalvariation: Variation

      The optional variation part of the sequencer to be started.

    Returns Promise<ShutdownSequencersResponse>

    ShutdownSequencersResponse as Promise.

  • shutdowns all the running sequencers found for given subsystem.

    Parameters

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

      The subsystem.

    Returns Promise<ShutdownSequencersResponse>

    ShutdownSequencersResponse as Promise.

  • starts a sequencer for given subsystem and observing mode. It starts a sequencer on an available sequence component for given subsystem.

    Parameters

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

      The subsystem of the sequencer to be started.

    • obsMode: ObsMode

      The obsMode of the sequencer to be started.

    • Optionalvariation: Variation

      The optional variation part of the sequencer to be started.

    Returns Promise<StartSequencerResponse>

    StartSequencerResponse as Promise.