API Documentation

TrafficSign

This describes a traffic sign. All coordinate data is in the parent frame.

TrafficSign::TrafficSign ( )

A default constructor.

TrafficSign::TrafficSign ( … )

A copy constructor.

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

TrafficSign::TrafficSign ( … )

A convenience constructor from a related type.

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

TrafficSign::~TrafficSign ( )

A default destructor.

TrafficSign::print ( … )

This will print internal values.

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

Returns

  • void

TrafficSign::get_ps_traffic_sign ( ) const

This will provide convenient access to a related type.

Returns

TrafficSign::operator= ( … )

An assignment operator.

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

TrafficSign::getTimestamp ( ) const

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

Returns

TrafficSign::setTimestamp ( … )

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

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

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

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

TrafficSign::getNativeTimestampFormat ( ) const

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

Returns
  • unsigned char

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

TrafficSign::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

TrafficSign::setNativeTimestampValue ( … )

This will set the timestamp value.

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

TrafficSign::getType ( ) const

This will get the sign type. TRAFFIC_SIGN_INVALID means that no sign is detected.

Returns

TrafficSign::setType ( … )

This will set the sign type. TRAFFIC_SIGN_INVALID means that no sign is detected.

Parameters
in/out type description
in ps_supplementary_sign_kind Sign type.
Returns
  • void

TrafficSign::getSupplementaryType ( ) const

This will get the supplementary type associated with the sign. Value SUPPLEMENTARY_SIGN_NOT_AVAILABLE means it is not available.

Returns

TrafficSign::setSupplementaryType ( … )

This will set the supplementary type associated with the sign. Value SUPPLEMENTARY_SIGN_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in ps_supplementary_sign_kind Supplementary type associated with the sign.
Returns
  • void

TrafficSign::getSpeedUnits ( ) const

This will get the traffic sign units.

Returns

TrafficSign::setSpeedUnits ( … )

This will set the traffic sign units.

Parameters
in/out type description
in ps_traffic_sign_unit_kind Traffic sign units.
Returns
  • void

TrafficSign::getPosition ( ) const

This will get the position of the sign. Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Returns
  • std::array< double, 3 >

TrafficSign::getPosition ( … )

This will set the position of the sign. Value PSYNC_POSITION_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in cosnt std::array< double, 3 > & Position of the sign.
Returns
  • void