API Documentation

PlatformTurnSignalCommandMessage

PlatformTurnSignalCommandMessage::PlatformTurnSignalCommandMessage ( )

A default constructor.

PlatformTurnSignalCommandMessage::PlatformTurnSignalCommandMessage ( … )

A copy constructor.

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

PlatformTurnSignalCommandMessage::PlatformTurnSignalCommandMessage ( … )

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

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

PlatformTurnSignalCommandMessage::PlatformTurnSignalCommandMessage ( … )

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

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

PlatformTurnSignalCommandMessage::PlatformTurnSignalCommandMessage ( … )

A convenience constructor from a related type.

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

PlatformTurnSignalCommandMessage::~PlatformTurnSignalCommandMessage ( )

A default destructor.

PlatformTurnSignalCommandMessage::print ( … )

This will print internal values.

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

PlatformTurnSignalCommandMessage::get_ps_platform_turn_signal_command_msg ( ) const

This provides convenient access of a related type.

Returns

PlatformTurnSignalCommandMessage::operator= ( … )

An assignment operator.

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

static PlatformTurnSignalCommandMessage::getName ( )

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

Returns
  • std::string

PlatformTurnSignalCommandMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformTurnSignalCommandMessage::setHeader ( … )

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

PlatformTurnSignalCommandMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformTurnSignalCommandMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformTurnSignalCommandMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformTurnSignalCommandMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformTurnSignalCommandMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformTurnSignalCommandMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

PlatformTurnSignalCommandMessage::getSensorDescriptor ( ) const

This will get the sensor descriptor.

Returns
  • datamode::SensorDescriptor

PlatformTurnSignalCommandMessage::setSensorDescriptor ( … )

This will set the sensor descriptor.

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

PlatformTurnSignalCommandMessage::getSensorDescriptorId ( ) const

This will get the sensor descriptor identifier.

Returns

PlatformTurnSignalCommandMessage::setSensorDescriptorId ( … )

This will set the sensor descriptor identifier.

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

PlatformTurnSignalCommandMessage::getSensorDescriptorType ( ) const

This will get the type of the sensor descriptor.

Returns

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

PlatformTurnSignalCommandMessage::getSensorDescriptorTransform ( ) const

This will get the sensor’s transform stack.

Returns

PlatformTurnSignalCommandMessage::setSensorDescriptorTransform ( … )

This will set the sensor’s transform stack.

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

PlatformTurnSignalCommandMessage::getSensorDescriptorTransformParentId ( ) const

This will get the transform stack’s parent identifier.

Returns

PlatformTurnSignalCommandMessage::setSensorDescriptorTransformParentId ( … )

This will set the transform stack’s parent identifier.

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

PlatformTurnSignalCommandMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

PlatformTurnSignalCommandMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

PlatformTurnSignalCommandMessage::getDestGuid ( ) const

This will get the destination node’s GUID.

Returns

PlatformTurnSignalCommandMessage::setDestGuid ( … )

This will set the destination node’s GUID.

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

PlatformTurnSignalCommandMessage::getTimestamp ( ) const

This will get the message’s timestamp.

Returns

PlatformTurnSignalCommandMessage::setTimestamp ( … )

This will set the message’s timestamp.

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

PlatformTurnSignalCommandMessage::getEStop ( ) const

This will get the emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Returns
  • unsigned char

PlatformTurnSignalCommandMessage::setEStop ( … )

This will set the emergency stop state.

PSYNC_EMERGENCY_STOP_DISABLED means disabled. Any other value means enabled.

Parameters
in/out type description
in unsigned char The byte field flag to be set.
Returns
  • void

PlatformTurnSignalCommandMessage::getTurnSignal ( ) const

This will get the desired turn signal state.

Returns

PlatformTurnSignalCommandMessage::setTurnSignal ( … )

This will set the desired turn signal state.

Parameters
in/out type description
in ps_platform_turn_signal_kind The desired turn signal state.
Returns
  • void