API Documentation

TrafficSignMessage

The global positioning system (GPS) accuracy message.

The header.timestamp stores the publish timestamp (updated by the publishing node).

Arbitration key member(s): header.src_guid, sensor_descriptor.id

TrafficSignMessage::TrafficSignMessage ( )

A default constructor.

TrafficSignMessage::TrafficSignMessage ( … )

A copy constructor.

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

TrafficSignMessage::TrafficSignMessage ( … )

A convenience constructor from a related type.

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

TrafficSignMessage::~TrafficSignMessage ( )

A default destructor.

TrafficSignMessage::print ( … )

This will print internal values.

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

Returns

  • void

TrafficSignMessage::get_ps_traffic_sign_msg ( ) const

This will provide convenient access to a related type.

Returns

TrafficSignMessage::operator= ( … )

An assignment operator.

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

static TrafficSignMessage::getName ( )

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

Returns
  • std::string

TrafficSignMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

TrafficSignMessage::setHeader ( … )

This will set the PolySync message header.

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

TrafficSignMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

TrafficSignMessage::setHeaderType ( … )

This will set the message type identifier.

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

TrafficSignMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

TrafficSignMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

TrafficSignMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

TrafficSignMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

TrafficSignMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

TrafficSignMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

TrafficSignMessage::getSensorDescriptorId ( ) const

This will get the identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means it is invalid.

Returns

TrafficSignMessage::setSensorDescriptorId ( … )

This will set the identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means it is invalid.

Parameters
in/out type description
in ps_identifier
Returns
  • void

TrafficSignMessage::getSensorDescriptorType ( ) const

This will get the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means it is invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means the type is not available.

Returns

TrafficSignMessage::setSensorDescriptorType ( … )

This will set the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means it is invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means the type is not available.

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

TrafficSignMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

TrafficSignMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

TrafficSignMessage::setSensorDescriptorTransformParentId ( … )

This will set the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means it is invalid.

Parameters
in/out type description
in ps_identifier The parent coordinate frame identifier.
Returns
  • void

TrafficSignMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

TrafficSignMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

TrafficSignMessage::getSigns ( ) const

This will get the traffic signs.

Returns

TrafficSignMessage::setSigns ( … )

This will set the traffic signs.

Parameters
in/out type description
in const std::vector< TrafficSign > & Traffic signs.
Returns
  • void