Class CallScriptRobotInstruction

Call scripted program instruction.

Remarks

Instructs the robot controller to execute the scripted robot program.

Hierarchy (View Summary)

RobotInstruction
- CallScriptRobotInstruction

Index

Constructors

Accessors

Methods

Constructors

constructor

new CallScriptRobotInstruction(): CallScriptRobotInstruction
Constructor.

Returns CallScriptRobotInstruction
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

script

get script(): Handle<RobotProgramComponent>
The scripted robot program.

Returns Handle<RobotProgramComponent>
set script(value: Handle<RobotProgramComponent>): void
Parameters
- value: Handle<RobotProgramComponent>
Returns void

Methods

execute

execute(controller: RobotControllerComponent): Future<void>
Executes the instruction.
Parameters
- controller: RobotControllerComponent
  The robot controller on which the instruction is to be executed.
Returns Future<void>
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