API Documentation

PlatformGearCommandMessage

A generic platform gear command message.

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

PlatformGearCommandMessage::PlatformGearCommandMessage ( )

A default constructor.

PlatformGearCommandMessage::PlatformGearCommandMessage ( … )

A copy constructor.

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

PlatformGearCommandMessage::PlatformGearCommandMessage ( … )

A convenience constructor from a related type.

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

PlatformGearCommandMessage::~PlatformGearCommandMessage ( )

A default destructor.

PlatformGearCommandMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformGearCommandMessage::get_ps_platform_gear_command_msg ( ) const

This will provide convenient access of a related type.

Returns

PlatformGearCommandMessage::operator= ( … )

An assignment operator.

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

static PlatformGearCommandMessage::getName ( )

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

Returns
  • std::string

PlatformGearCommandMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformGearCommandMessage::setHeader ( … )

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

PlatformGearCommandMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformGearCommandMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformGearCommandMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformGearCommandMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformGearCommandMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformGearCommandMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformGearCommandMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformGearCommandMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformGearCommandMessage::getSensorDescriptorId ( ) const

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

Returns

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

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

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

PlatformGearCommandMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

PlatformGearCommandMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

PlatformGearCommandMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformGearCommandMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformGearCommandMessage::getDestGuid ( ) const

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

Returns

PlatformGearCommandMessage::setDestGuid ( … )

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

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

PlatformGearCommandMessage::getTimestamp ( ) const

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

Returns

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

PlatformGearCommandMessage::getEStop ( ) const

This will get an emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

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

PlatformGearCommandMessage::getGearPosition ( ) const

This will get the desired gear position. Value GEAR_POSITION_INVALID means no gear command applied.

Returns

PlatformGearCommandMessage::setGearPosition ( … )

This will set a desired gear position. Value GEAR_POSITION_INVALID means no gear command applied.

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