Class WaitAnySequenceOperation

Wait any operation.

Remarks

Instructs the sequence to execute multiple operations, but wait only until any one of them has finished.

Hierarchy (View Summary)

SequenceOperation
- WaitAnySequenceOperation

Index

Constructors

Accessors

operations sequence

Methods

Constructors

constructor

new WaitAnySequenceOperation(): WaitAnySequenceOperation
Constructor.

Returns WaitAnySequenceOperation
Overrides SequenceOperation.constructor

Accessors

operations

get operations(): SequenceOperation[]
The operations to be executed.

Returns SequenceOperation[]
set operations(value: SequenceOperation[]): void
Parameters
- value: SequenceOperation[]
Returns void

sequence

get sequence(): null | SequenceManager
The sequence to which the operation has been assigned.

Returns null | SequenceManager
Remarks
If the sequence is null then the operation hasn't been added to a program.

Inherited from SequenceOperation.sequence
set sequence(value: null | SequenceManager): void
Parameters
- value: null | SequenceManager
Returns void
Inherited from SequenceOperation.sequence

Methods

execute

execute(component: SequenceComponent): Future<void>
Executes the operation.
Parameters
- component: SequenceComponent
  The sequence component on which the operation is to be executed.
Returns Future<void>
The future that is resolved once the operation has been executed.

Remarks
This function is called by the sequence when it commands it to execute.

Overrides SequenceOperation.execute

label

label(units: InspectorUnits): string
The label for the operation, as it is to be displayed in the inspector.
Parameters
- units: InspectorUnits
  The unit settings for the inspector.
Returns string
The label.

Overrides SequenceOperation.label