Class StopRobotMessage

An abstract message used to stop a robot. This message looks to the server like a DriveRobotMessage with power set to 0.

Hierarchy

DriveRobotMessage
- StopRobotMessage

Index

Constructors

Properties

id leftPower rightPower type

Methods

Constructors

constructor

new StopRobotMessage(id: string): StopRobotMessage
Parameters
- id: string
Returns StopRobotMessage
Overrides DriveRobotMessage.constructor
- Defined in src/common/message/drive-robot-message.ts:29

Properties

`Readonly` id

id: string

`Readonly` leftPower

leftPower: number

`Readonly` rightPower

rightPower: number

`Protected` type

type: MessageType = MessageType.DRIVE_ROBOT

Methods

toJson

toJson(): string
Serializes the message as json.

Returns string
Inherited from DriveRobotMessage.toJson
- Defined in src/common/message/message.ts:45

`Protected` toObj

toObj(): object
Sends this class to an object which can be serialized as json. The only usage of this method is by toJson.

Returns object
Inherited from DriveRobotMessage.toObj
- Defined in src/common/message/drive-robot-message.ts:14

Generated using TypeDoc