API Documentation

PlatformThrottleCommandMessage

A generic platform throttle command message.

Arbitration key member(s): header.src_guid, dest_guid

PlatformThrottleCommandMessage::PlatformThrottleCommandMessage ( )

A default constructor.

PlatformThrottleCommandMessage::PlatformThrottleCommandMessage ( … )

A copy constructor.

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

PlatformThrottleCommandMessage::PlatformThrottleCommandMessage ( … )

A convenience constructor from a related type.

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

PlatformThrottleCommandMessage::~PlatformThrottleCommandMessage ( )

A default destructor.

PlatformThrottleCommandMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformThrottleCommandMessage::get_ps_platform_throttle_command_msg ( ) const

This will provide convenient access of a related type.

Returns

PlatformThrottleCommandMessage::operator= ( … )

An assignment operator.

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

static PlatformThrottleCommandMessage::getName ( )

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

Returns
  • std::string

PlatformThrottleCommandMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformThrottleCommandMessage::setHeader ( … )

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

PlatformThrottleCommandMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformThrottleCommandMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformThrottleCommandMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformThrottleCommandMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformThrottleCommandMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformThrottleCommandMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformThrottleCommandMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformThrottleCommandMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformThrottleCommandMessage::getSensorDescriptorId ( ) const

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

Returns

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

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

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

PlatformThrottleCommandMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformThrottleCommandMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformThrottleCommandMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformThrottleCommandMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformThrottleCommandMessage::getDestGuid ( ) const

This will get the destination GUID. PSYNC_GUID_INVALID means not used.

Returns

PlatformThrottleCommandMessage::setDestGuid ( … )

This will set the destination GUID. PSYNC_GUID_INVALID means not used.

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

PlatformThrottleCommandMessage::getTimestamp ( ) const

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

Returns

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

PlatformThrottleCommandMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

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

PlatformThrottleCommandMessage::getEnabled ( ) const

This will get a desired throttle enabled state.

A value of zero means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformThrottleCommandMessage::setEnabled ( … )

This will set the desired throttle enabled state.

A value of zero means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char Desired throttle enabled state.
Returns
  • void

PlatformThrottleCommandMessage::getThrottleCommandType ( ) const

This will get the throttle command kind. It indicates what type of throttle command to apply. Value THROTTLE_COMMAND_INVALID indicates what type of throttle command to apply.

Returns

PlatformThrottleCommandMessage::setThrottleCommandType ( … )

This will set the throttle command kind. It indicates what type of throttle command to apply. Value THROTTLE_COMMAND_INVALID indicates what type of throttle command to apply.

Parameters
in/out type description
in ps_throttle_command_kind Throttle command kind.
Returns
  • void

PlatformThrottleCommandMessage::getThrottleCommand ( ) const

This will get the desired throttle pedal command value. It specifies the pedal percentage (normalized) when throttle_command_type is set to THROTTLE_COMMAND_PEDAL. It also specifies the percentage of maximum throttle (normalized) when throttle_command_type is set to THROTTLE_COMMAND_PERCENT. A value of zero means no throttle applied. [normalized]

Returns
  • float

PlatformThrottleCommandMessage::setThrottleCommand ( … )

This will set the desired throttle pedal command value. It specifies the pedal percentage (normalized) when throttle_command_type is set to THROTTLE_COMMAND_PEDAL. It also specifies the percentage of maximum throttle (normalized) when throttle_command_type is set to THROTTLE_COMMAND_PERCENT. A value of zero means no throttle applied. [normalized]

Parameters
in/out type description
in float Desired throttle pedal command value.
Returns
  • void