API Documentation

RadarTargetsMessage

The radar targets message.

Arbitration key member(s): header.src_guid

RadarTargetsMessage::RadarTargetsMessage ( )

A default constructor.

RadarTargetsMessage::RadarTargetsMessage ( … )

A copy constructor.

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

RadarTargetsMessage::RadarTargetsMessage ( … )

A convenience constructor from a related type.

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

RadarTargetsMessage::~RadarTargetsMessage ( )

A default destructor.

RadarTargetsMessage::print ( … )

This will print internal values.

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

Returns

  • void

RadarTargetsMessage::get_ps_radar_targets_msg ( ) const

This will provide convenient access to a related type.

Returns

RadarTargetsMessage::operator= ( … )

An assignment operator.

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

static RadarTargetsMessage::getName ( )

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

Returns
  • std::string

RadarTargetsMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

RadarTargetsMessage::setHeader ( … )

This will set the PolySync message header.

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

RadarTargetsMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

RadarTargetsMessage::setHeaderType ( … )

This will set the message type identifier.

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

RadarTargetsMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

RadarTargetsMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

RadarTargetsMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

RadarTargetsMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

RadarTargetsMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

RadarTargetsMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

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

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

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

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

RadarTargetsMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

RadarTargetsMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

RadarTargetsMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

RadarTargetsMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

RadarTargetsMessage::getObjects ( ) const

This will get the radar targets.

Returns

RadarTargetsMessage::setObjects ( … )

This will set the radar targets.

Parameters
in/out type description
in const std::vector< RadarTarget > & Radar targets.
Returns
  • void