API Documentation

LaneModel

This describes a lane model. Validity is determined using the quality value.

LaneModel::LaneModel ( )

A default constructor.

LaneModel::LaneModel ( … )

A copy constructor.

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

LaneModel::LaneModel ( … )

The convenience constructor from a related type.

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

LaneModel::~LaneModel ( )

A default destructor.

LaneModel::print ( … )

This will print internal values.

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

Returns

  • void

LaneModel::get_ps_lane_model ( ) const

This will provide convenient access to a related type.

Returns

LaneModel::operator= ( … )

An assignment operator.

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

LaneModel::getTimestamp ( ) const

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

Returns

LaneModel::setTimestamp ( … )

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

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

LaneModel::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 invalid.

Returns

LaneModel::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 invalid.

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

LaneModel::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.

Returns
  • unsigned char

LaneModel::setNativeTimestampFormat ( … )

This will set the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.

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

LaneModel::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

LaneModel::setNativeTimestampValue ( … )

This will set the timestamp value.

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

LaneModel::getQuality( ) const

This will get the detection quality for the lane.

It is used to indicate lane validity. Value QUALITY_INVALID means the lane is invalid.

Returns

LaneModel::setQuality ( … )

This will set the detection quality for the lane.

It is used to indicate lane validity. Value QUALITY_INVALID means the lane is invalid.

Parameters
in/out type description
in ps_quality_kind Detection quality for the lane, used to indicate lane validity.
Returns
  • void

LaneModel::getMarkerType( ) const

This will get the marker/boundary type. Value LANE_MARKER_UNKNOWN means undecided.

Returns

LaneModel::setMarkerType ( … )

This will set the marker/boundary type. Value LANE_MARKER_UNKNOWN means undecided.

Parameters
in/out type description
in ps_lane_marker_kind Marker/boundary type.
Returns
  • void

LaneModel::getModelType ( ) const

This will get the lane curve model type.

Returns

LaneModel::setModelType ( … )

This will set the lane curve model type.

Parameters
in/out type description
in ps_lane_curve_model_kind Lane curve model type.
Returns
  • void

LaneModel::getMarkerWidth ( ) const

This will get the marker width. [meters]

Returns
  • double

LaneModel::setMarkerWidth ( … )

This will set the marker width. [meters]

Parameters
in/out type description
in double Marker width. [meters]
Returns
  • void

LaneModel::getHeadingAngle ( ) const

This will get the angle of the marker. [radians] Value PSYNC_HEADING_NOT_AVAILABLE means the value is not available.

Returns
  • double

LaneModel::setHeadingAngle ( … )

This will set the angle of the marker. [radians] Value PSYNC_HEADING_NOT_AVAILABLE means the value is not available.

Parameters
in/out type description
in double Angle of the marker. [radians]
Returns
  • void

LaneModel::getViewRange ( ) const

This will get the visible range of the marker. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means it is not available.

Returns
  • double

LaneModel::setViewRange ( … )

This will set the visible range of the marker. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Visible range of the marker. [meters]
Returns
  • void

LaneModel::getMarkerOffset ( ) const

This will get the lateral position/offset of the marker. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means it is not available.

Returns
  • double

LaneModel::setMarkerOffset ( … )

This will get the lateral position/offset of the marker. [meters] Value PSYNC_POSITION_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Lateral position/offset of the marker. [meters]
Returns
  • void

LaneModel::getCurvature ( ) const

This will get the curvature of the lane. [1/meters] Value PSYNC_HEADING_NOT_AVAILABLE means value is not available.

Returns
  • double

LaneModel::setCurvature ( … )

This will set the curvature of the lane. [1/meters] Value PSYNC_HEADING_NOT_AVAILABLE means value is not available.

Parameters
in/out type description
in double Curvature of the lane. [1/meters]
Returns
  • void

LaneModel::getCurvatureDerivative ( ) const

This will get the curvature of the lane. [1/meters] Value PSYNC_HEADING_NOT_AVAILABLE means value is not available.

Returns
  • double

LaneModel::setCurvatureDerivative ( … )

This will set the curvature of the lane. [1/meters^2] Value PSYNC_HEADING_NOT_AVAILABLE means value is not available.

Parameters
in/out type description
in double Curvature of the lane. [1/meters^2]
Returns
  • void

LaneModel::getTimeToCrossing ( ) const

This will get the time to lane crossing. [microseconds] Value zero means it is not valid.

Returns

LaneModel::setTimeToCrossing ( … )

This will set the time to lane crossing. [microseconds] Value zero means it is not valid.

Parameters
in/out type description
in ps_timestamp Time to lane crossing. [microseconds]
Returns
  • void