API Documentation

Object

A generic spatial object. This describes a generic spatial object. All coordinate data is in the parent frame

Object::Object ( )

A default constructor.

Object::Object ( … )

A copy constructor.

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

Object::Object ( … )

A convenience constructor from a related type.

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

Object::~Object ( )

A default destructor.

Object::print ( … )

This will print internal values.

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

Returns

  • void

Object::get_ps_object ( ) const

This will provide convenient access to a related type.

Returns

Object::operator= ( … )

An assignment operator.

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

Object::getId ( ) const

This will get an identifier from tracking.

Returns

Object::setId ( … )

This will set an identifier from tracking.

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

Object::getTimestamp ( ) const

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

Returns

Object::setTimestamp ( … )

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

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

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

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

Object::getNativeTimestampFormat ( ) const

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

Returns
  • unsigned char

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

Object::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

Object::setNativeTimestampValue ( … )

This will set the timestamp value.

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

Object::getPosition ( ) const

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

Returns
  • std::array< double, 3 >

Object::setPosition ( … )

This will set the position of the object. [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 object. [xyz meters]
Returns
  • void

Object::getSize ( ) const

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

Returns
  • std::array< double, 3 >

Object::setSize ( … )

This will set the size of the object. [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 object. [xyz meters]
Returns
  • void

Object::getVelocity ( ) const

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

Returns
  • std::array< double, 3 >

Object::setVelocity ( … )

Thsi will set the velocity of an object. [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 object. [xyz meters/second]
Returns
  • void

Object::getCourseAngle ( ) const

This will get the orientation/heading of the object. [radians] Value PSYNC_HEADING_NOT_AVAILABLE means the value is not available.

Returns
  • double

Object::setCourseAngle ( … )

This will get the orientation/heading of the object. [radians] Value PSYNC_HEADING_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in double Orientation/heading of the object. [radians]
Returns
  • void

Object::getClassification ( ) const

This will get the most likely classification of the object.

Returns

Object::setClassification ( … )

This will set the most likely classification of the object.

Parameters
in/out type description
in ps_object_classification_kind Most likely classification of the object.
Returns
  • void

Object::getClassificationQuality ( ) const

This will get the classification quality. The higher the quality, the more reliable the object classification is.

Returns

Object::setClassificationQuality ( … )

This will set the classification quality. The higher the quality, the more reliable the object classification is.

Parameters
in/out type description
in ps_quality_kind Classification quality. The higher the quality, the more reliable the object classification is.
Returns
  • void