API Documentation

PlatformBrakeCommandMessage

Generic platform brake command message.

Arbitration key member(s): header.src_guid, dest_guid

PlatformBrakeCommandMessage::PlatformBrakeCommandMessage ( )

Default constructor.

PlatformBrakeCommandMessage::PlatformBrakeCommandMessage ( … )

The copy constructor.

Parameters
in/out type description
in const PlatformBrakeCommandMessage & Instance being copied.

PlatformBrakeCommandMessage::PlatformBrakeCommandMessage ( … )

The convenience constructor from related type.

Parameters
in/out type description
in const ps_platform_brake_command_msg & Instance of related type.

PlatformBrakeCommandMessage::~PlatformBrakeCommandMessage ( )

The default destructor.

PlatformBrakeCommandMessage::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream which defaults to std::cout.

Returns

  • void

PlatformBrakeCommandMessage::get_ps_platform_brake_command_msg ( ) const

This provides convenient access of a related type.

Returns

PlatformBrakeCommandMessage::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const PlatformBrakeCommandMessage & Instance to copy.
Returns
  • PlatformBrakeCommandMessage &

static PlatformBrakeCommandMessage::getName ( )

This will get message name.

It is useful in functions requiring message names such as getMessageTypeByName.

Returns
  • std::string

PlatformBrakeCommandMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformBrakeCommandMessage::setHeader ( … )

Parameters
in/out type description
in MsgHeader & Message header.
Returns
  • void

PlatformBrakeCommandMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformBrakeCommandMessage::setHeaderType ( … )

This will set a message type identifier.

Parameters
in/out type description
in ps_msg_type Message type identifier.
Returns
  • void

PlatformBrakeCommandMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformBrakeCommandMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

Parameters
in/out type description
in ps_timestamp In microseconds.
Returns
  • void

PlatformBrakeCommandMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformBrakeCommandMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

Parameters
in/out type description
in ps_guid Message producer’s GUID.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformBrakeCommandMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

Parameters
in/out type description
in SensorDescriptor & Standard sensor descriptor.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorId ( ) const

This will get an identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorId ( … )

This will set an identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.

Parameters
in/out type description
in ps_identifier
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorType ( ) const

This will get the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means type not available.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorType ( … )

This will set the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means type not available.

Parameters
in/out type description
in ps_sensor_kind The sensor descriptor type.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorTransform ( ) const

This will get the transform that describes this data’s coordinate frame.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorTransform ( … )

This will set the transform that describes this data’s coordinate frame.

Parameters
in/out type description
in TransformStack & The transform that describes this data’s coordinate frame.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorTransformParentId ( ) const

This will get the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means invalid.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorTransformParentId ( … )

This will set the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means invalid.

Parameters
in/out type description
in ps_identifier The parent coordinate frame identifier.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorTransformTimestamp ( ) const

This will get the last update timestamp of the parent, and/or any of its children transformations.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorTransformTimestamp ( … )

This will set the last update timestamp of the parent, and/or any of its children transformations.

Parameters
in/out type description
in ps_timestamp The last update timestamp of the transform.
Returns
  • void

PlatformBrakeCommandMessage::getSensorDescriptorTransformStack ( ) const

This will get the transformation stack that describes a PolySync transformation.

Returns

PlatformBrakeCommandMessage::setSensorDescriptorTransformStack ( … )

This will set the transformation stack that describes a PolySync transformation.

Parameters
in/out type description
in std::vector<TransformDescriptor> & The transformation stack.
Returns
  • void

PlatformBrakeCommandMessage::getDestGuid ( ) const

This will get a destination GUID. PSYNC_GUID_INVALID means not used.

Returns

PlatformBrakeCommandMessage::setDestGuid ( … )

This will set a destination GUID. PSYNC_GUID_INVALID means not used.

Parameters
in/out type description
in ps_guid Destination GUID.
Returns
  • void

PlatformBrakeCommandMessage::getTimestamp ( ) const

This will get the timestamp associated with the control command(s). [UTC microsecond]

Returns

PlatformBrakeCommandMessage::setTimestamp ( … )

This will set the timestamp associated with the control command(s). [UTC microsecond]

Parameters
in/out type description
in ps_timestamp Timestamp associated with the control command(s). [UTC microsecond]
Returns
  • void

PlatformBrakeCommandMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformBrakeCommandMessage::setEStop ( … )

This will set an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char Emergency stop state.
Returns
  • void

PlatformBrakeCommandMessage::getEnabled ( ) const

This will get the desired brake on-off (brake lights) state.

Value zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformBrakeCommandMessage::setEnabled ( … )

This will set the desired brake on-off (brake lights) state.

Value zero means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char Desired brake on-off (brake lights) state.
Returns
  • void

PlatformBrakeCommandMessage::getBooEnabled ( ) const

This will get the desired brake on-off (brake lights) state.

Value zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformBrakeCommandMessage::setBooEnabled ( … )

This will set the desired brake on-off (brake lights) state.

Value zero means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char Desired brake on-off (brake lights) state.
Returns
  • void

PlatformBrakeCommandMessage::getBrakeCommandType ( ) const

This will get the brake command kind.

It indicates what type of brake command to apply. BRAKE_COMMAND_INVALID means no brake command applied.

Returns

PlatformBrakeCommandMessage::setBrakeCommandType ( … )

This will set the brake command kind.

It indicates what type of brake command to apply. BRAKE_COMMAND_INVALID means no brake command applied.

Parameters
in/out type description
in ps_brake_command_kind Brake command kind.
Returns
  • void

PlatformBrakeCommandMessage::getBrakeCommand ( ) const

This will get the desired brake pedal command value.

It specifies the pedal percentage (normalized) when the brake_command_type is set to BRAKE_COMMAND_PEDAL. It also specifies the percentage of maximum torque (normalized) when the brake_command_type is set to BRAKE_COMMAND_PERCENT. Value zero means no brake applied. [normalized]

Returns
  • float

PlatformBrakeCommandMessage::setBrakeCommand ( … )

This will set the desired brake pedal command value.

It specifies the pedal percentage (normalized) when the brake_command_type is set to BRAKE_COMMAND_PEDAL. It also specifies the percentage of maximum torque (normalized) when the brake_command_type is set to BRAKE_COMMAND_PERCENT. Value zero means no brake applied. [normalized]

Parameters
in/out type description
in float Desired brake pedal command value.
Returns
  • void