Class MoveCommand`Abstract`

Represents a robot translation in x and y.

Note this may involve the robot turning first. The orientation after the move is unspecified.

Hierarchy

RobotCommand
- MoveCommand
  - RelativeMoveCommand
  - AbsoluteMoveCommand

Index

Constructors

Properties

_requirements position robotId

Accessors

Methods

addRequirements execute then

Constructors

constructor

new MoveCommand(robotId: string, position: Position): MoveCommand
Parameters
- robotId: string
- position: Position
Returns MoveCommand
Overrides RobotCommand.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 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

`Abstract` execute

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

Returns Promise<void>
Inherited from RobotCommand.execute
- Defined in src/server/command/command.ts:40

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