Class DriveCommand

Drives a robot for a distance equal to a number of tiles. Distance may be negative, indicating the robot drives backwards.

Does not modify robot's stored position, must be done on the caller's side.

Hierarchy

RobotCommand
- DriveCommand

Implements

Reversible<DriveCommand>

Index

Constructors

Properties

_requirements robotId tileDistance

Accessors

Methods

addRequirements execute reverse then

Constructors

constructor

new DriveCommand(robotId: string, tileDistance: number): DriveCommand
Parameters
- robotId: string
- tileDistance: number
Returns DriveCommand
Overrides RobotCommand.constructor
- Defined in src/server/command/move-command.ts:96

Properties

`Protected` _requirements

_requirements: Set<object> = ...

`Readonly` robotId

robotId: string

tileDistance

tileDistance: number

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:103

reverse

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

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