Class RobotProgram

Exportable robot program.

Remarks

An exportable robot program consists of an ordered list of instructions to be executed in sequence.

Implements

IRobotProgram

Index

Accessors

controller instructions name

Methods

add execute remove

Accessors

controller

get controller(): null | RobotControllerComponent
The controller to which the program has been assigned.

Returns null | RobotControllerComponent
Remarks
If the controller is null then the program hasn't been added to a controller.
set controller(value: null | RobotControllerComponent): void
Parameters
- value: null | RobotControllerComponent
Returns void

instructions

get instructions(): readonly RobotInstruction[]
The ordered list of instructions.

Returns readonly RobotInstruction[]
set instructions(value: RobotInstruction[]): void
Parameters
- value: RobotInstruction[]
Returns void

name

get name(): string
The unique name that identifies the program.

Returns string
Implementation of IRobotProgram.name

Methods

add

add(instruction: RobotInstruction): boolean
Attempts to add the specified instruction to the program.
Parameters
- instruction: RobotInstruction
  The instruction.
Returns boolean
True if the instruction was added, flase otherwise.

execute

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

Implementation of IRobotProgram.execute

remove

remove(instruction: RobotInstruction): boolean
Attempts to remove the specified instruction from the program.
Parameters
- instruction: RobotInstruction
  The instruction.
Returns boolean
True if the instruction was removed, flase otherwise.