Class AwaitSignalRobotInstruction

Await signal instruction.

Remarks

Instructs the robot controller to wait until the specified robot controller signal reports the given value.

Hierarchy (View Summary)

RobotInstruction
- AwaitSignalRobotInstruction

Index

Constructors

Accessors

program signal timeout value

Methods

Constructors

constructor

new AwaitSignalRobotInstruction(): AwaitSignalRobotInstruction
Constructor.

Returns AwaitSignalRobotInstruction
Overrides RobotInstruction.constructor

Accessors

program

get program(): null | RobotProgram
The program to which the instruction has been assigned.

Returns null | RobotProgram
Remarks
If the program is null then the instruction hasn't been added to a program.

Inherited from RobotInstruction.program
set program(value: null | RobotProgram): void
Parameters
- value: null | RobotProgram
Returns void
Inherited from RobotInstruction.program

signal

get signal(): string
The signal name.

Returns string
set signal(value: string): void
Parameters
- value: string
Returns void

timeout

get timeout(): number
Wait timeout in seconds.

Returns number
Remarks
The instruction will complete if the timeout is exceeded, regardless of whether the value was seen. Set to zero to disable the timeout.
set timeout(value: number): void
Parameters
- value: number
Returns void

value

get value(): SignalValueType
The value to wait for.

Returns SignalValueType
set value(value: SignalValueType): void
Parameters
- value: SignalValueType
Returns void

Methods

execute

execute(controller: RobotControllerComponent): Future<any>
Executes the instruction.
Parameters
- controller: RobotControllerComponent
  The robot controller on which the instruction is to be executed.
Returns Future<any>
The future that is resolved once the instruction has been executed.

Overrides RobotInstruction.execute

label

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

Overrides RobotInstruction.label