API Documentation

RadarTarget

The radar provided target. This describes a target or track being estimated based on radar data. Validity is determined using the ps_radar_target.track_status value. All coordinate data is in the parent frame.

RadarTarget::RadarTarget ( )

A default constructor.

RadarTarget::RadarTarget ( … )

A copy constructor.

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

RadarTarget::RadarTarget ( … )

A convenience constructor from a related type.

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

RadarTarget::~RadarTarget ( )

A default destructor.

RadarTarget::print ( … )

This will print internal values.

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

Returns

  • void

RadarTarget::get_ps_radar_target ( ) const

This will provide convenient access to a related type.

Returns

RadarTarget::operator= ( … )

An assignment operator.

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

RadarTarget::getId ( ) const

This will get the identifier from tracking.

Returns

RadarTarget::setId ( … )

This will set the identifier from tracking.

Parameters
in/out type description
in ps_identifier Identifier from tracking.
Returns
  • void

RadarTarget::getTimestamp ( ) const

This will get the last updated timestamp. [UTC microseconds]

Returns

RadarTarget::setTimestamp ( … )

This will set the last updated timestamp. [UTC microseconds]

Parameters
in/out type description
in ps_timestamp The last update timestamp.
Returns
  • void

RadarTarget::getNativeTimestamp ( ) const

This will get the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns

RadarTarget::setNativeTimestamp ( … )

This will set the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in NativeTimestamp &
Returns
  • void

RadarTarget::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns
  • unsigned char

RadarTarget::setNativeTimestampFormat ( … )

This will set the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in unsigned char Timestamp format.
Returns
  • void

RadarTarget::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

RadarTarget::setNativeTimestampValue ( … )

This will set the timestamp value.

Parameters
in/out type description
in unsigned long long Timestamp value.
Returns
  • void

RadarTarget::getPosition ( ) const

This will get the position of the radartarget. [xyz meters] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 3 >

RadarTarget::setPosition ( … )

This will set the position of the radartarget. [xyz meters] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Position of radartarget. [xyz meters]
Returns
  • void

RadarTarget::getSize ( ) const

This will get the size of the radartarget. [xyz meters] Value PSYNC_SIZE_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 3 >

RadarTarget::setSize ( … )

This will set the size of the radartarget. [xyz meters] Value PSYNC_SIZE_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Size of radartarget. [xyz meters]
Returns
  • void

RadarTarget::getVelocity ( ) const

This will get the velocity of the radartarget. [xyz meters] Value PSYNC_VELOCITY_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 3 >

RadarTarget::setVelocity ( … )

This will set the velocity of the radartarget. [xyz meters/second] Value PSYNC_VELOCITY_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Velocity of radartarget. [xyz meters/second]
Returns
  • void

RadarTarget::getRangeRate ( ) const

This will get the range rate (or sometimes the Doppler velocity) of target. [meters/second] Value PSYNC_VELOCITY_NOT_AVAILABLE means the value is not available.

Returns
  • double

RadarTarget::setRangeRate ( … )

This will set the range rate (or sometimes the Doppler velocity) of target. [meters/second] Value PSYNC_VELOCITY_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in double Range rate (or sometimes the Doppler velocity) of target. [meters/second]
Returns
  • void

RadarTarget::getTrackStatus ( ) const

If this target is a track, this provides its status if supported. Value TRACK_STATUS_RAW_TARGET means this is a raw target/measurement and not a track.

Returns

RadarTarget::setTrackStatus ( … )

If this target is a track, this provides its status if supported. Value TRACK_STATUS_RAW_TARGET means this is a raw target/measurement and not a track.

Parameters
in/out type description
in ps_track_status_kind If this target is a track, this provides its status if supported.
Returns
  • void

RadarTarget::getRangeType ( ) const

This will get the target range type.

Returns

RadarTarget::setRangeType ( … )

This will set the target range type.

Parameters
in/out type description
in ps_range_kind Target range type.
Returns
  • void

RadarTarget::getZoneType ( ) const

This will get the target zone type.

Returns

RadarTarget::setZoneType ( … )

This will set the target zone type.

Parameters
in/out type description
in ps_zone_kind Target zone type.
Returns
  • void

RadarTarget::getQuality ( ) const

This will get the target quality.

Returns

RadarTarget::setQuality ( … )

This will set the target quality.

Parameters
in/out type description
in ps_quality_kind
Returns
  • void

RadarTarget::getAmplitude ( ) const

This will get the target amplitude. [decibels] Value PSYNC_AMPLITUDE_NOT_AVAILABLE means the value is not available.

Returns
  • double

RadarTarget::setAmplitude ( … )

This will set the target amplitude. [decibels] Value PSYNC_AMPLITUDE_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in double Target amplitude.
Returns
  • void

RadarTarget::getMagnitude ( ) const

This will get the target magnitude. [decibels] Value PSYNC_MAGNITUDE_NOT_AVAILABLE means the value is not available.

Returns
  • double

RadarTarget::setMagnitude ( … )

This will set the target magnitude. [decibels] Value PSYNC_MAGNITUDE_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in double Target magnitude.
Returns
  • void

RadarTarget::getAlias ( ) const

This will get the target range rate alias (or sometimes the Doppler alias) of target relative to the parent coordinate frame. [meters/second] Value PSYNC_VELOCITY_ALIAS_NOT_AVAILABLE means it is not available.

Returns
  • double

RadarTarget::setAlias ( … )

This will set the target range rate alias (or sometimes the Doppler alias) of the target relative to the parent coordinate frame. [meters/second] Value PSYNC_VELOCITY_ALIAS_NOT_AVAILABLE means this is not available.

Parameters
in/out type description
in double Target range rate alias (or sometimes the Doppler alias).
Returns
  • void

RadarTarget::getCrossSection ( ) const

This will get the target radar cross section. [meters^2] Value PSYNC_RADAR_CROSS_SECTION_NOT_AVAILABLE means it is not available.

Returns
  • double

RadarTarget::setCrossSection ( … )

This will set the target radar cross section. [meters^2] Value PSYNC_RADAR_CROSS_SECTION_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Target radar cross section. [meters^2]
Returns
  • void

RadarTarget::getScanIndex ( ) const

This will set the target scan index. Value zero means it is unknown or not available.

Returns
  • unsigned long

RadarTarget::setScanIndex ( … )

This will set the target scan index. Value zero means it is unknown or not available.

Parameters
in/out type description
in unsigned long Target scan index.
Returns
  • void