API Documentation

PlatformObdMessage

A platform OBD message.

Arbitration key member(s): header.src_guid, sensor_descriptor.id

PlatformObdMessage::PlatformObdMessage ( )

A default constructor.

PlatformObdMessage::PlatformObdMessage ( … )

A copy constructor.

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

PlatformObdMessage::PlatformObdMessage ( … )

A convenience constructor from a related type.

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

PlatformObdMessage::~PlatformObdMessage ( )

A default destructor.

PlatformObdMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformObdMessage::get_ps_platform_obd_msg ( ) const

This will provide convenient access to a related type.

Returns

PlatformObdMessage::operator= ( … )

An assignment operator.

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

static PlatformObdMessage::getName ( )

This will get a message name.

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

Returns
  • std::string

PlatformObdMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformObdMessage::setHeader ( … )

This will set a PolySync message header.

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

PlatformObdMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformObdMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformObdMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformObdMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformObdMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformObdMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformObdMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformObdMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformObdMessage::getSensorDescriptorId ( ) const

This will get an identifier.

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

Returns

PlatformObdMessage::setSensorDescriptorId ( … )

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

Parameters
in/out type description
in ps_identifier
Returns
  • void

PlatformObdMessage::getSensorDescriptorType ( ) const

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

Returns

PlatformObdMessage::setSensorDescriptorType ( … )

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

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

PlatformObdMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformObdMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

PlatformObdMessage::setSensorDescriptorTransformParentId ( … )

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

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

PlatformObdMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformObdMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformObdMessage::getTimestamp ( ) const

This will get the last updated timestamp. [UTC microseconds]

Returns

PlatformObdMessage::setTimestamp ( … )

This will set the last updated timestamp. [UTC microseconds]

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

PlatformObdMessage::getNativeTimestamp ( ) const

This will get the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns

PlatformObdMessage::setNativeTimestamp ( … )

This will set the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in NativeTimestamp &
Returns
  • void

PlatformObdMessage::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns
  • unsigned char

PlatformObdMessage::setNativeTimestampFormat ( … )

This will set the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in unsigned char Timestamp format.
Returns
  • void

PlatformObdMessage::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

PlatformObdMessage::setNativeTimestampValue ( … )

This will set the timestamp value.

Parameters
in/out type description
in unsigned long long Timestamp value.
Returns
  • void

PlatformObdMessage::getPid ( ) const

This will get the PID (Parameter ID) of the OBD response.

Returns

PlatformObdMessage::setPid ( … )

This will set the PID (Parameter ID) of the OBD response.

Parameters
in/out type description
in ps_identifier PID (Parameter ID) of the OBD response.
Returns
  • void

PlatformObdMessage::getData ( ) const

This will get the value of the OBD response corresponding to the PID.

Returns

PlatformObdMessage::setData ( … )

This will set the value of the OBD response corresponding to the PID.

Parameters
in/out type description
in ps_parameter_value Value of OBD response corresponding to the PID.
Returns
  • void