Class ReversibleAbsoluteMoveCommand

Moves a robot to a global location. Implements Reversible through a position supplier to return to the previous position.

Hierarchy

RobotCommand
- ReversibleAbsoluteMoveCommand

Implements

Reversible<ReversibleAbsoluteMoveCommand>

Index

Constructors

Properties

_requirements positionSupplier previousPosition robotId

Accessors

Methods

addRequirements execute reverse then

Constructors

constructor

new ReversibleAbsoluteMoveCommand(robotId: string, positionSupplier: (() => Position)): ReversibleAbsoluteMoveCommand
Parameters
- robotId: string
- positionSupplier: (() => Position)
  - - (): Position
    - Returns Position
Returns ReversibleAbsoluteMoveCommand
Overrides RobotCommand.constructor
- Defined in src/server/command/move-command.ts:166

Properties

`Protected` _requirements

_requirements: Set<object> = ...

`Protected` positionSupplier

positionSupplier: (() => Position)

Type declaration

- (): Position
- Returns Position

`Private` previousPosition

previousPosition: undefined | Position

`Readonly` robotId

robotId: string

Accessors

requirements

get requirements(): Set<object>
The set of objects that this command requires to execute. Used to place mutexes on common resources to ensure they don't receive multiple inputs at once.

Returns Set<object>
Inherited from RobotCommand.requirements
- Defined in src/server/command/command.ts:46

Methods

`Protected` addRequirements

addRequirements(reqs: object[]): void
A utility method for adding multiple requirements at once.
Parameters
- reqs: object[]
Returns void
Inherited from RobotCommand.addRequirements
- Defined in src/server/command/command.ts:53

execute

execute(): Promise<void>
Executes the command.

Returns Promise<void>
Overrides RobotCommand.execute
- Defined in src/server/command/move-command.ts:173

reverse

reverse(): ReversibleAbsoluteMoveCommand
Returns ReversibleAbsoluteMoveCommand
Implementation of Reversible.reverse
- Defined in src/server/command/move-command.ts:179

then

then(next: Command): SequentialCommandGroup
Implicitly wraps a Command into a Sequential Command.
Parameters
- next: Command
  
  The command which is run next.
Returns SequentialCommandGroup
Inherited from RobotCommand.then
- Defined in src/server/command/command.ts:42

Generated using TypeDoc