API Documentation

PlatformGearReportMessage

A generic platform gear report message.

Arbitration key member(s): header.src_guid

PlatformGearReportMessage::PlatformGearReportMessage ( )

A default constructor.

PlatformGearReportMessage::PlatformGearReportMessage ( … )

A copy constructor.

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

PlatformGearReportMessage::PlatformGearReportMessage ( … )

A convenience constructor from related type.

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

PlatformGearReportMessage::~PlatformGearReportMessage ( )

A default destructor.

PlatformGearReportMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformGearReportMessage::get_ps_platform_gear_report_msg ( ) const

This provides convenient access of a related type.

Returns

PlatformGearReportMessage::operator= ( … )

An assignment operator.

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

static PlatformGearReportMessage::getName ( )

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

Returns
  • std::string

PlatformGearReportMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

PlatformGearReportMessage::setHeader ( … )

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

PlatformGearReportMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

PlatformGearReportMessage::setHeaderType ( … )

This will set the message type identifier.

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

PlatformGearReportMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

PlatformGearReportMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformGearReportMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

PlatformGearReportMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

PlatformGearReportMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformGearReportMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformGearReportMessage::getSensorDescriptorId ( ) const

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

Returns

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

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

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

PlatformGearReportMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformGearReportMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformGearReportMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformGearReportMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformGearReportMessage::getTimestamp ( ) const

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

Returns

PlatformGearReportMessage::setTimestamp ( … )

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

PlatformGearReportMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

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

PlatformGearReportMessage::getControlMode ( ) const

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

PlatformGearReportMessage::setControlMode ( … )

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

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

PlatformGearReportMessage::getPosition ( ) const

This will get the gear position.

Returns

PlatformGearReportMessage::setPosition ( … )

This will set the gear position.

Parameters
in/out type description
in ps_gear_position_kind Gear position.
Returns
  • void

PlatformGearReportMessage::getPositionCommand ( ) const

This will get the gear position command.

Returns

PlatformGearReportMessage::setPositionCommand ( … )

This will set the gear position command.

Parameters
in/out type description
in ps_gear_position_kind Gear position command.
Returns
  • void