API Documentation

PlatformBrakeReportMessage

A generic platform brake report message.

Arbitration key member(s): header.src_guid

PlatformBrakeReportMessage::PlatformBrakeReportMessage ( )

A default constructor.

PlatformBrakeReportMessage::PlatformBrakeReportMessage ( … )

A copy constructor.

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

PlatformBrakeReportMessage::PlatformBrakeReportMessage ( … )

A convenience constructor from a related type.

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

PlatformBrakeReportMessage::~PlatformBrakeReportMessage ( )

A default destructor.

PlatformBrakeReportMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformBrakeReportMessage::get_ps_platform_brake_report_msg ( ) const

This will provide convenient access of related type.

Returns

PlatformBrakeReportMessage::operator= ( … )

An assignment operator.

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

static PlatformBrakeReportMessage::getName ( )

This will get a message name. It is useful in functions requiring message names such as getMessageTypeByName.

Returns
  • std::string

PlatformBrakeReportMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformBrakeReportMessage::setHeader ( … )

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

PlatformBrakeReportMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformBrakeReportMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformBrakeReportMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformBrakeReportMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformBrakeReportMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformBrakeReportMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformBrakeReportMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformBrakeReportMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformBrakeReportMessage::getSensorDescriptorId ( ) const

This will get an identifier. In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.

Returns

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

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

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

PlatformBrakeReportMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformBrakeReportMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformBrakeReportMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformBrakeReportMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformBrakeReportMessage::getTimestamp ( ) const

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

Returns

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

PlatformBrakeReportMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

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

PlatformBrakeReportMessage::getControlMode ( ) const

This will get the brake control mode.

Value PLATFORM_CONTROL_MODE_MANUAL means brake controls are applied by the driver. Value PLATFORM_CONTROL_MODE_AUTONOMOUS means brake controls are applied autonomously.

Returns

PlatformBrakeReportMessage::setControlMode ( … )

This will set the brake control mode.

Value PLATFORM_CONTROL_MODE_MANUAL means brake controls are applied by the driver. Value PLATFORM_CONTROL_MODE_AUTONOMOUS means brake controls are applied autonomously.

Parameters
in/out type description
in ps_platform_control_mode_kind Brake control mode.
Returns
  • void

PlatformBrakeReportMessage::getEnabled ( ) const

This will get the brake enabled state.

Value zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformBrakeReportMessage::setEnabled ( … )

This will set the brake enabled 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

PlatformBrakeReportMessage::getPedalInput ( ) const

This will get the brake pedal input value. [normalized]

Returns
  • float

PlatformBrakeReportMessage::setPedalInput ( … )

This will set the brake pedal input value. [normalized]

Parameters
in/out type description
in float Brake pedal input value. [normalized]
Returns
  • void

PlatformBrakeReportMessage::getPedalCommand ( ) const

This will get the brake pedal command value. [normalized]

Returns
  • float

PlatformBrakeReportMessage::setPedalCommand ( … )

This will set the brake pedal command value. [normalized]

Parameters
in/out type description
in float Brake pedal command value. [normalized]
Returns
  • void

PlatformBrakeReportMessage::getPedalOutput ( ) const

This will get the brake pedal output value. [normalized]

Returns
  • float

PlatformBrakeReportMessage::setPedalOutput ( … )

This will set the brake pedal output value. [normalized]

Parameters
in/out type description
in float Brake pedal output value. [normalized]
Returns
  • void

PlatformBrakeReportMessage::getTorqueInput ( ) const

This will get the braking torque input value. [Newton meter]

Returns
  • float

PlatformBrakeReportMessage::setTorqueInput ( … )

This will set the braking torque input value. [Newton meter]

Parameters
in/out type description
in float Braking torque input value. [Newton meter]
Returns
  • void

PlatformBrakeReportMessage::getTorqueCommand ( ) const

This will get the braking torque command value. [Newton meter]

Returns
  • float

PlatformBrakeReportMessage::setTorqueCommand ( … )

This will set the braking torque command value. [Newton meter]

Parameters
in/out type description
in float Braking torque command value. [Newton meter]
Returns
  • void

PlatformBrakeReportMessage::getTorqueOutput ( ) const

This will get the braking torque output value. [Newton meter]

Returns
  • float

PlatformBrakeReportMessage::setTorqueOutput ( … )

This will set the braking torque output value. [Newton meter]

Parameters
in/out type description
in float Braking torque output value. [Newton meter]
Returns
  • void