SequencerService | @tmtsoftware/esw-ts

Hierarchy

SequencerService

Index

Methods

abortSequence

abortSequence(): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:164
Discards all the pending steps of the sequence and call the abort handler of the sequencer's script

Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

add

add(commands: SequenceCommand[]): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:51
Adds the given list of sequence commands at the end of the sequence

Parameters
- commands: SequenceCommand[]
  
  list of SequenceCommand to add in the sequence of sequencer
Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

addBreakpoint

addBreakpoint(id: string): Promise<GenericResponse>

- Defined in src/clients/sequencer/SequencerService.ts:93
Adds a breakpoint at the command of the given id in the sequence

Parameters
- id: string
  
  runId of the command where breakpoint is to be added
Returns Promise<GenericResponse>

GenericResponse as Promise

delete

delete(id: string): Promise<GenericResponse>

- Defined in src/clients/sequencer/SequencerService.ts:85
Deletes the command of the given id in the sequence

Parameters
- id: string
  
  runId of the command which is to be deleted
Returns Promise<GenericResponse>

GenericResponse as Promise

diagnosticMode

diagnosticMode(startTime: Date, hint: string): Promise<DiagnosticModeResponse>

- Defined in src/clients/sequencer/SequencerService.ts:180
Sends command to the sequencer to call the diagnostic mode handler of the sequencer's script

Parameters
- startTime: Date
  
  time at which the diagnostic mode will take effect
- hint: string
  
  String to support diagnostic data mode
Returns Promise<DiagnosticModeResponse>

DiagnosticModeResponse as Promise

getSequence

getSequence(): Promise<Option<StepList>>

- Defined in src/clients/sequencer/SequencerService.ts:129
Gets the sequence present in the sequencer

Returns Promise<Option<StepList>>

Option as Promise

getSequencerState

getSequencerState(): Promise<SequencerState>

- Defined in src/clients/sequencer/SequencerService.ts:233
Returns the current state of the sequencer (Idle, Loaded, Offline, Running, Processing)

Returns Promise<SequencerState>

SequencerState

goOffline

goOffline(): Promise<GoOfflineResponse>

- Defined in src/clients/sequencer/SequencerService.ts:157
sends command to the sequencer to go in Offline state if it is in Online state

Returns Promise<GoOfflineResponse>

GoOfflineResponse as Promise

goOnline

goOnline(): Promise<GoOnlineResponse>

- Defined in src/clients/sequencer/SequencerService.ts:150
sends command to the sequencer to go in Online state if it is in Offline state

Returns Promise<GoOnlineResponse>

GoOnlineResponse as Promise

insertAfter

insertAfter(id: string, commands: SequenceCommand[]): Promise<GenericResponse>

- Defined in src/clients/sequencer/SequencerService.ts:77
Inserts the given list of sequence commands after the command of given id in the sequence

Parameters
- id: string
  
  runId of command after which the given list of commands is to be inserted
- commands: SequenceCommand[]
  
  list of SequenceCommand to be inserted
Returns Promise<GenericResponse>

GenericResponse as Promise

isAvailable

isAvailable(): Promise<boolean>

- Defined in src/clients/sequencer/SequencerService.ts:136
Checks if sequencer is in Idle state

Returns Promise<boolean>

boolean as Promise

isOnline

isOnline(): Promise<boolean>

- Defined in src/clients/sequencer/SequencerService.ts:143
Checks if sequencer is in Online(any state except Offline) state

Returns Promise<boolean>

boolean as Promise

loadSequence

loadSequence(sequence: Sequence): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:36
Loads the given sequence to the sequencer

Parameters
- sequence: Sequence
  
  a sequence to load in the sequencer
Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

operationsMode

operationsMode(): Promise<OperationsModeResponse>

- Defined in src/clients/sequencer/SequencerService.ts:187
Sends command to the sequencer to call the operations mode handler of the sequencer's script

Returns Promise<OperationsModeResponse>

OperationsModeResponse as Promise

pause

pause(): Promise<PauseResponse>

- Defined in src/clients/sequencer/SequencerService.ts:122
Pauses the sequence

Returns Promise<PauseResponse>

PauseResponse as Promise

prepend

prepend(commands: SequenceCommand[]): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:59
Prepends the given list of sequence commands in the sequence

Parameters
- commands: SequenceCommand[]
  
  list of SequenceCommand to prepend in the sequence of sequencer
Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

query

query(runId: string): Promise<SubmitResponse>

- Defined in src/clients/sequencer/SequencerService.ts:215
Queries the response of sequence of the given runId and returns the immediate SubmitResponse

Parameters
- runId: string
  
  runId of the sequence
Returns Promise<SubmitResponse>

SubmitResponse as Promise

queryFinal

queryFinal(runId: string, timeoutInSeconds: number): Promise<SubmitResponse>

- Defined in src/clients/sequencer/SequencerService.ts:227
Queries the response of the sequence of given id and returns the final SubmitResponse If sequence is not finished it waits till the given timeout

Parameters
- runId: string
  
  runId of the sequence
- timeoutInSeconds: number
  
  timeout within which result is expected.
Returns Promise<SubmitResponse>

SubmitResponse as Promise

removeBreakpoint

removeBreakpoint(id: string): Promise<RemoveBreakpointResponse>

- Defined in src/clients/sequencer/SequencerService.ts:101
Removes a breakpoint from the command of the given id in the sequence

Parameters
- id: string
  
  runId of command where breakpoint is
Returns Promise<RemoveBreakpointResponse>

GenericResponse as Promise

replace

replace(id: string, commands: SequenceCommand[]): Promise<GenericResponse>

- Defined in src/clients/sequencer/SequencerService.ts:68
Replaces the command of the given id with the given list of sequence commands in the sequence

Parameters
- id: string
  
  runId of command which is to be replaced
- commands: SequenceCommand[]
  
  list of SequenceCommand to replace with
Returns Promise<GenericResponse>

GenericResponse as Promise

reset

reset(): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:108
Resets the sequence by discarding all the pending steps of the sequence

Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

resume

resume(): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:115
Resumes the paused sequence

Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

startSequence

startSequence(): Promise<SubmitResponse>

- Defined in src/clients/sequencer/SequencerService.ts:43
Runs the loaded sequence

Returns Promise<SubmitResponse>

SubmitResponse as Promise

stop

stop(): Promise<OkOrUnhandledResponse>

- Defined in src/clients/sequencer/SequencerService.ts:171
Discards all the pending steps of the sequence and call the stop handler of the sequencer's script

Returns Promise<OkOrUnhandledResponse>

OkOrUnhandledResponse as Promise

submit

submit(sequence: Sequence): Promise<SubmitResponse>

- Defined in src/clients/sequencer/SequencerService.ts:196
Submit the given sequence to the sequencer and returns the immediate SubmitResponse.

Parameters
- sequence: Sequence
  
  sequence to run on the sequencer
Returns Promise<SubmitResponse>

SubmitResponse as Promise

submitAndWait

submitAndWait(sequence: Sequence, timeoutInSeconds: number): Promise<SubmitResponse>

- Defined in src/clients/sequencer/SequencerService.ts:206
Submit the given sequence to the sequencer and waits until sequence execution completed and returns the final SubmitResponse

Parameters
- sequence: Sequence
  
  sequence to run on the sequencer
- timeoutInSeconds: number
  
  timeout within which result is expected.
Returns Promise<SubmitResponse>

SubmitResponse as Promise

subscribeSequencerState

subscribeSequencerState(): (onStateChange: (sequencerStateResponse: SequencerStateResponse) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

- Defined in src/clients/sequencer/SequencerService.ts:245
Subscribes to the changes in state of sequencer which includes SequencerState (i.e Idle, Loaded, etc) and current StepList. The callback will be called with new SequencerStateResponse on state change and returns a subscription to unsubscribe.

Returns (onStateChange: (sequencerStateResponse: SequencerStateResponse) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

Subscription
- - (onStateChange: (sequencerStateResponse: SequencerStateResponse) => void, onError?: (error: ServiceError) => void, onClose?: () => void): Subscription
  - Subscribes to the changes in state of sequencer which includes SequencerState (i.e Idle, Loaded, etc) and current StepList. The callback will be called with new SequencerStateResponse on state change and returns a subscription to unsubscribe.
    
    Parameters
    - onStateChange: (sequencerStateResponse: SequencerStateResponse) => void
      
      the function which gets called on each state change
      - (sequencerStateResponse: SequencerStateResponse): void
        
        the function which gets called on each state change
        
        Parameters
        
        sequencerStateResponse: SequencerStateResponse
        
        Returns void
    - Optional onError: (error: ServiceError) => void
      
      a optional error callback which gets called on receiving error. it can be Parsing error or a Runtime error [for ex. Gateway exception]
      - (error: ServiceError): void
        
        a optional error callback which gets called on receiving error. it can be Parsing error or a Runtime error [for ex. Gateway exception]
        
        Parameters
        
        error: ServiceError
        
        Returns void
    - Optional onClose: () => void
      
      a optional close callback which gets called when the connection is closed.
      - (): void
        
        a optional close callback which gets called when the connection is closed.
        
        Returns void
    Returns Subscription
    
    Subscription

Hierarchy

Index

Methods

Methods

abortSequence

Returns Promise<OkOrUnhandledResponse>

add

Parameters

commands: SequenceCommand[]

Returns Promise<OkOrUnhandledResponse>

addBreakpoint

Parameters

id: string

Returns Promise<GenericResponse>

delete

Parameters

id: string

Returns Promise<GenericResponse>

diagnosticMode

Parameters

startTime: Date

hint: string

Returns Promise<DiagnosticModeResponse>

getSequence

Returns Promise<Option<StepList>>

getSequencerState

Returns Promise<SequencerState>

goOffline

Returns Promise<GoOfflineResponse>

goOnline

Returns Promise<GoOnlineResponse>

insertAfter

Parameters

id: string

commands: SequenceCommand[]

Returns Promise<GenericResponse>

isAvailable

Returns Promise<boolean>

isOnline

Returns Promise<boolean>

loadSequence

Parameters

sequence: Sequence

Returns Promise<OkOrUnhandledResponse>

operationsMode

Returns Promise<OperationsModeResponse>

pause

Returns Promise<PauseResponse>

prepend

Parameters

commands: SequenceCommand[]

Returns Promise<OkOrUnhandledResponse>

query

Parameters

runId: string

Returns Promise<SubmitResponse>

queryFinal

Parameters

runId: string

timeoutInSeconds: number

Returns Promise<SubmitResponse>

removeBreakpoint

Parameters

id: string

Returns Promise<RemoveBreakpointResponse>

replace

Parameters

id: string

commands: SequenceCommand[]

Returns Promise<GenericResponse>

reset

Returns Promise<OkOrUnhandledResponse>

resume

Returns Promise<OkOrUnhandledResponse>

startSequence

Returns Promise<SubmitResponse>

stop

Returns Promise<OkOrUnhandledResponse>

submit

Parameters