Class MovePiece

Executes a set of setupMoves in parallel, followed by a mainMove. The setupMoves are automatically undone afterwards.

Hierarchy

SequentialCommandGroup
- MovePiece

Index

Constructors

Properties

_requirements commands mainMove setupMoves

Accessors

Methods

addRequirements execute then

Constructors

constructor

new MovePiece(setupMoves: ReversibleRobotCommand[], mainMove: Command): MovePiece
Parameters
- setupMoves: ReversibleRobotCommand[]
- mainMove: Command
Returns MovePiece
Overrides SequentialCommandGroup.constructor
- Defined in src/server/command/move-piece.ts:17

Properties

`Protected` _requirements

_requirements: Set<object> = ...

`Readonly` commands

commands: Command[]

mainMove

mainMove: Command

setupMoves

setupMoves: ReversibleRobotCommand[]

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

execute

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

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

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

Generated using TypeDoc