API Documentation

PlatformThrottleReportMessage

A generic platform throttle report message.

Arbitration key member(s): header.src_guid

PlatformThrottleReportMessage::PlatformThrottleReportMessage ( )

A default constructor.

PlatformThrottleReportMessage::PlatformThrottleReportMessage ( … )

A copy constructor.

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

PlatformThrottleReportMessage::PlatformThrottleReportMessage ( … )

A convenience constructor from a related type.

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

PlatformThrottleReportMessage::~PlatformThrottleReportMessage ( )

A default destructor.

PlatformThrottleReportMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformThrottleReportMessage::get_ps_platform_throttle_report_msg ( ) const

This will provide convenient access of a related type.

Returns

PlatformThrottleReportMessage::operator= ( … )

An assignment operator.

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

static PlatformThrottleReportMessage::getName ( )

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

Returns
  • std::string

PlatformThrottleReportMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformThrottleReportMessage::setHeader ( … )

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

PlatformThrottleReportMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformThrottleReportMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformThrottleReportMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformThrottleReportMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformThrottleReportMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformThrottleReportMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformThrottleReportMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformThrottleReportMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformThrottleReportMessage::getSensorDescriptorId ( ) const

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

Returns

PlatformThrottleReportMessage::setSensorDescriptorId ( … )

This will set 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

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

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

PlatformThrottleReportMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformThrottleReportMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformThrottleReportMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

PlatformThrottleReportMessage::setSensorDescriptorTransformTimestamp ( … )

This will set the last updated 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

PlatformThrottleReportMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformThrottleReportMessage::getTimestamp ( ) const

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

Returns

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

PlatformThrottleReportMessage::getEStop ( ) const

This will get the emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformThrottleReportMessage::setEStop ( … )

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

PlatformThrottleReportMessage::getControlMode ( ) const

This will get the throttle 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

PlatformThrottleReportMessage::setControlMode ( … )

This will set the throttle control mode.

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

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

PlatformThrottleCommandMessage::getEnabled ( ) const

This will get the throttle enabled state.

A value of zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformThrottleCommandMessage::setEnabled ( … )

This will set the throttle enabled state.

A value of zero means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char Desired enabled state.
Returns
  • void

PlatformThrottleReportMessage::getPedalInput ( ) const

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

Returns
  • float

PlatformThrottleReportMessage::setPedalInput ( … )

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

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

PlatformThrottleReportMessage::getPedalCommand ( ) const

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

Returns
  • float

PlatformThrottleReportMessage::setPedalCommand ( … )

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

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

PlatformThrottleReportMessage::getPedalOutput ( ) const

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

Returns
  • float

PlatformThrottleReportMessage::setPedalOutput ( … )

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

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