Class RelativeMoveCommand

Shifts a robot a relative amount. The heading of the robot after the move is arbitrary.

Hierarchy

MoveCommand
- RelativeMoveCommand

Implements

Reversible<RelativeMoveCommand>

Index

Constructors

Properties

_requirements position robotId

Accessors

Methods

addRequirements execute reverse then

Constructors

constructor

new RelativeMoveCommand(robotId: string, position: Position): RelativeMoveCommand
Parameters
- robotId: string
- position: Position
Returns RelativeMoveCommand
Inherited from MoveCommand.constructor
- Defined in src/server/command/move-command.ts:120

Properties

`Protected` _requirements

_requirements: Set<object> = ...

`Protected` position

position: 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 MoveCommand.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 MoveCommand.addRequirements
- Defined in src/server/command/command.ts:53

execute

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

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

reverse

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

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 MoveCommand.then
- Defined in src/server/command/command.ts:42

Generated using TypeDoc