API Documentation

PlatformTirePressureReportMessage

A generic platform tire pressure report message.

Arbitration key member(s): header.src_guid

PlatformTirePressureReportMessage::PlatformTirePressureReportMessage ( )

A default constructor.

PlatformTirePressureReportMessage::PlatformTirePressureReportMessage ( … )

A copy constructor.

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

PlatformTirePressureReportMessage::PlatformTirePressureReportMessage ( … )

A convenience constructor from related type.

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

PlatformTirePressureReportMessage::~PlatformTirePressureReportMessage ( )

A default destructor.

PlatformTirePressureReportMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformTirePressureReportMessage::get_ps_platform_tire_pressure_report_msg ( ) const

A convenient access of related type.

Returns

PlatformTirePressureReportMessage::operator= ( … )

An assignment operator.

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

static PlatformTirePressureReportMessage::getName ( )

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

Returns
  • std::string

PlatformTirePressureReportMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

PlatformTirePressureReportMessage::setHeader ( … )

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

PlatformTirePressureReportMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

PlatformTirePressureReportMessage::setHeaderType ( … )

This will set the message type identifier.

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

PlatformTirePressureReportMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

PlatformTirePressureReportMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

PlatformTirePressureReportMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

PlatformTirePressureReportMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

PlatformTirePressureReportMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

PlatformTirePressureReportMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

PlatformTirePressureReportMessage::getSensorDescriptorId ( ) const

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

Returns

PlatformTirePressureReportMessage::setSensorDescriptorId ( … )

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

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

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

PlatformTirePressureReportMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformTirePressureReportMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformTirePressureReportMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformTirePressureReportMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformTirePressureReportMessage::getTimestamp ( ) const

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

Returns

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

PlatformTirePressureReportMessage::getFrontLeft ( ) const

This will get the front left tire pressure. [Pascals]

Returns
  • float

PlatformTirePressureReportMessage::setFrontLeft ( … )

This will set the front left tire pressure. [Pascals]

Parameters
in/out type description
in float Front left tire pressure. [Pascals]
Returns
  • void

PlatformTirePressureReportMessage::getFrontRight ( ) const

This will get the front right tire pressure. [Pascals]

Returns
  • float

PlatformTirePressureReportMessage::setFrontRight ( … )

This will set the front right tire pressure. [Pascals]

Parameters
in/out type description
in float Front right tire pressure. [Pascals]
Returns
  • void

PlatformTirePressureReportMessage::getRearLeft ( ) const

This will get the rear left tire pressure. [Pascals]

Returns
  • float

PlatformTirePressureReportMessage::setRearLeft ( … )

This will set the rear left tire pressure. [Pascals]

Parameters
in/out type description
in float Rear left tire pressure. [Pascals]
Returns
  • void

PlatformTirePressureReportMessage::getRearRight ( ) const

This will get the rear right tire pressure. [Pascals]

Returns
  • float

PlatformTirePressureReportMessage::setRearRight ( … )

This will set the rear right tire pressure. [Pascals]

Parameters
in/out type description
in float Rear right tire pressure. [Pascals]
Returns
  • void