API Documentation

PsZone

A generic 2-D zone.

Validity is determined using the quality value. It describes a measurement zone, and all coordinate data is in the parent frame.

PsZone::PsZone ( )

A default constructor.

PsZone::PsZone ( … )

A copy constructor.

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

PsZone::PsZone ( … )

A convenience constructor from a related type.

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

PsZone::~PsZone ( )

A default destructor.

PsZone::print ( … )

This will print internal values.

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

Returns

  • void

PsZone::get_ps_zone ( ) const

This will provide convenient access to a related type.

Returns

PsZone::operator= ( … )

An assignment operator.

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

PsZone::getId ( ) const

Thsi will get an identifier from tracking.

Returns

PsZone::setId ( … )

This will set an identifier from tracking.

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

PsZone::getTimestamp ( ) const

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

Returns

PsZone::setTimestamp ( … )

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

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

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

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

PsZone::getNativeTimestampFormat ( ) const

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

Returns
  • unsigned char

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

PsZone::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

PsZone::setNativeTimestampValue ( … )

This will set the timestamp value.

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

PsZone::getZoneAlertKind ( ) const

This will get the alert kind. Value ZONE_ALERT_NONE means no alert.

Returns

PsZone::setZoneAlertKind ( … )

This will set the alert kind. ZONE_ALERT_NONE means no alert.

Parameters
in/out type description
in ps_zone_alert_kind Alert kind.
Returns
  • void

PsZone::getDistances ( ) const

This will get start and end distances of zone. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 2 >

PsZone::setDistances ( … )

This will se the start and end distances of zone. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 2 > & Set start and end distances of zone. [meters]
Returns
  • void

PsZone::getHorizontalAngles ( ) const

This will get the start and end x-y horizontal angles of zone. [radians] Value PSYNC_ANGLE_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 2 >

PsZone::setHorizontalAngles ( … )

This will set the start and end x-y horizontal angles of zone. [radians] Value PSYNC_ANGLE_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 2 > & Start and end x-y horizontal angles of zone. [radians]
Returns
  • void

PsZone::getVerticalAngles ( ) const

This will start and end x-z vertical angles of zone. [radians] Value PSYNC_ANGLE_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 2 >

PsZone::setVerticalAngles ( … )

This start and end x-z vertical angles of zone. [radians] Value PSYNC_ANGLE_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 2 > & Start and end x-z vertical angles of zone. [radians]
Returns
  • void

PsZone::getOrigin ( ) const

This will get the cartesian coordinates of zone origin. [xyz] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 3 >

PsZone::setOrigin ( … )

This will set the cartesian coordinates of zone origin. [xyz] Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Cartesian coordinates of zone origin. [xyz]
Returns
  • void

PsZone::getOrientation ( ) const

This will get the orientation quaternion. [xyzw quaternion] PSYNC_ORIENTATION_NOT_AVAILABLE means it is not available.

Returns
  • std::array< double, 4 >

PsZone::setOrientation ( … )

This will set the orientation quaternion. [xyzw quaternion] PSYNC_ORIENTATION_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in const std::array< double, 4 > & Orientation quaternion. [xyzw quaternion]
Returns
  • void

PsZone::getQuality ( ) const

This will get the zone measurement quality.

Returns

PsZone::setQuality ( … )

This will set the zone measurement quality.

Parameters
in/out type description
in ps_quality_kind Zone measurement quality.
Returns
  • void