API Documentation

PlatformWheelSpeedReportMessage

A generic platform wheel speed report message.

PlatformWheelSpeedReportMessage::PlatformWheelSpeedReportMessage ( )

A default constructor.

PlatformWheelSpeedReportMessage::PlatformWheelSpeedReportMessage ( … )

A copy constructor.

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

PlatformWheelSpeedReportMessage::PlatformWheelSpeedReportMessage ( … )

This will pair with a node to construct and enable publishing.

Parameters
in/out type description
in Node & Reference to node.

PlatformWheelSpeedReportMessage::PlatformWheelSpeedReportMessage ( … )

This will pair with a node to construct and enable publishing and messaging.

Parameters
in/out type description
in Node & Reference to node.
in ps_msg_ref Message to copy.

PlatformWheelSpeedReportMessage::PlatformWheelSpeedReportMessage ( … )

A convenience constructor from a related type.

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

PlatformWheelSpeedReportMessage::~PlatformWheelSpeedReportMessage ( )

A default destructor.

PlatformWheelSpeedReportMessage::print ( … )

This will print internal values.

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

PlatformWheelSpeedReportMessage::get_ps_platform_turn_signal_command_msg ( ) const

This will provide convenient access of a related type.

Returns

PlatformWheelSpeedReportMessage::operator= ( … )

An assignment operator.

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

static PlatformWheelSpeedReportMessage::getName ( )

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

Returns
  • std::string

PlatformWheelSpeedReportMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformWheelSpeedReportMessage::setHeader ( … )

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

PlatformWheelSpeedReportMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformWheelSpeedReportMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformWheelSpeedReportMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformWheelSpeedReportMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformWheelSpeedReportMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformWheelSpeedReportMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformWheelSpeedReportMessage::getSensorDescriptor ( ) const

This will get the sensor descriptor.

Returns
  • datamode::SensorDescriptor

PlatformWheelSpeedReportMessage::setSensorDescriptor ( … )

This will set the sensor descriptor.

Parameters
in/out type description
in datamode::SensorDescriptor & The copied sensor descriptor.
Returns
  • void

PlatformWheelSpeedReportMessage::getSensorDescriptorId ( ) const

This will get the sensor descriptor identifier.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorId ( … )

This will set the sensor descriptor identifier.

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

PlatformWheelSpeedReportMessage::getSensorDescriptorType ( ) const

This will get the type of the sensor descriptor.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorType ( … )

This will set the type of the sensor descriptor.

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

PlatformWheelSpeedReportMessage::getSensorDescriptorTransform ( ) const

This will get the sensor’s transform stack.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorTransform ( … )

This will set the sensor’s transform stack.

Parameters
in/out type description
in datamodel::TransformStack & The transform stack.
Returns
  • void

PlatformWheelSpeedReportMessage::getSensorDescriptorTransformParentId ( ) const

This will get the transform stack’s parent identifier.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorTransformParentId ( … )

Set the transform stack’s parent’s identifier.

Parameters
in/out type description
in ps_identifier The transform stack’s parent identifier.
Returns
  • void

PlatformWheelSpeedReportMessage::getSensorDescriptorTransformTimestamp ( ) const

This will get the last updated timestamp of the sensor’s transform stack.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorTransformTimestamp ( … )

This will set the last updated timestamp of the sensor’s transform stack.

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

PlatformWheelSpeedReportMessage::getSensorDescriptorTransformStack ( ) const

This will get the transform descriptors of the associated transform stack.

Returns

PlatformWheelSpeedReportMessage::setSensorDescriptorTransformStack ( … )

This will set the transform descriptors of the associated transform stack.

Parameters
in/out type description
in const std::vector< datamodel::TransformDescriptor > & The transform descriptors to be copied.
Returns
  • void

PlatformWheelSpeedReportMessage::getDestGuid ( ) const

This will get the destination node’s GUID.

Returns

PlatformWheelSpeedReportMessage::setDestGuid ( … )

This will set the destination node’s GUID.

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

PlatformWheelSpeedReportMessage::getTimestamp ( ) const

This will get the message’s timestamp.

Returns

PlatformWheelSpeedReportMessage::setTimestamp ( … )

This will set the message’s timestamp.

Parameters
in/out type description
in ps_timestamp The set timestamp value.
Returns
  • void

PlatformWheelSpeedReportMessage::getFrontLeft ( ) const

This will get the speed of the front left wheel in radians per second.

Returns
  • float

PlatformWheelSpeedReportMessage::setFrontLeft ( … )

This will set the speed of the front left wheel in radians per second.

Parameters
in/out type description
in float The wheel speed in radians/second.
Returns
  • void

PlatformWheelSpeedReportMessage::getFrontRight ( ) const

This will get the speed of the front right wheel in radians per second.

Returns
  • float

PlatformWheelSpeedReportMessage::setFrontRight ( … )

This will set the speed of the front right wheel in radians per second.

Parameters
in/out type description
in float The wheel speed in radians/second.
Returns
  • void

PlatformWheelSpeedReportMessage::getRearLeft ( ) const

This will get the speed of the rear left wheel in radians per second.

Returns
  • float

PlatformWheelSpeedReportMessage::setRearLeft ( … )

This will set the speed of the rear left wheel in radians per second.

Parameters
in/out type description
in float The wheel speed in radians/second.
Returns
  • void

PlatformWheelSpeedReportMessage::getRearRight ( ) const

This will get the speed of the rear right wheel in radians per second.

Returns
  • float

PlatformWheelSpeedReportMessage::setRearRight ( … )

This will set the speed of the rear right wheel in radians per second.

Parameters
in/out type description
in float The wheel speed in radians/second.
Returns
  • void