API Documentation

PlatformCabinReportMessage

A generic platform cabin report message.

Arbitration key member(s): header.src_guid

PlatformCabinReportMessage::PlatformCabinReportMessage ( )

A default constructor.

PlatformCabinReportMessage::PlatformCabinReportMessage ( … )

A copy constructor.

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

PlatformCabinReportMessage::PlatformCabinReportMessage ( … )

A convenience constructor from related type.

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

PlatformCabinReportMessage::~PlatformCabinReportMessage ( )

A default destructor.

PlatformCabinReportMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformCabinReportMessage::get_ps_platform_cabin_report_msg ( ) const

This will provide convenient access of related type.

Returns

PlatformCabinReportMessage::operator= ( … )

An assignment operator.

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

static PlatformCabinReportMessage::getName ( )

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

Returns
  • std::string

PlatformCabinReportMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformCabinReportMessage::setHeader ( … )

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

PlatformCabinReportMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformCabinReportMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformCabinReportMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [ microseconds ]

Returns

PlatformCabinReportMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [ microseconds ]

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

PlatformCabinReportMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformCabinReportMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformCabinReportMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformCabinReportMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformCabinReportMessage::getSensorDescriptorId ( ) const

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

Returns

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

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

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

PlatformCabinReportMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformCabinReportMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformCabinReportMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformCabinReportMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformCabinReportMessage::getTimestamp ( ) const

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

Returns

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

PlatformCabinReportMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

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

PlatformCabinReportMessage::getTurnSignal ( ) const

This will get the turn signal state.

PlatformCabinReportMessage::setTurnSignal ( … )

This will set the turn signal state.

Parameters
in/out type description
in ps_platform_turn_signal_kind Turn signal state.
Returns
  • void

PlatformCabinReportMessage::getHighBeamHeadlights ( ) const

This will get the high beam headlight state.

Value zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformCabinReportMessage::setHighBeamHeadlights ( … )

This will set the high beam headlight state.

Value zero means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char High beam headlight state.
Returns
  • void

PlatformCabinReportMessage::getWiperState ( ) const

This will get the wiper state.

Returns

PlatformCabinReportMessage::setWiperState ( … )

This will set the wiper state.

Parameters
in/out type description
in ps_platform_wiper_state_kind Wiper state.
Returns
  • void