API Documentation

Enumerations

Sensor Module Enumerations

ps_gps_fix_kind

GPS fix kinds.

Value Description
GPS_FIX_INVALID GPS fix information is invalid.
GPS_FIX_UNKNOWN GPS fix information is unknown.
GPS_FIX_NOT_AVAILABLE GPS fix information is not available.
GPS_FIX_NONE No GPS fix.
GPS_FIX_2D 2D GPS fix.
GPS_FIX_3D 3D GPS fix.
GPS_FIX_KIND_COUNT Number of ps_gps_fix_kind values.

ps_lane_curve_model_kind

Lane curve model kinds.

See ps_lane_model for example usage documentation.

Value Description
LANE_CURVE_MODEL_INVALID Lane curve model information is invalid.
LANE_CURVE_MODEL_UNKNOWN Lane curve model information is unknown.
LANE_CURVE_MODEL_NOT_AVAILABLE Lane curve model information is not available.
LANE_CURVE_MODEL_LINEAR Linear curve model.
LANE_CURVE_MODEL_PARABOLIC Parabolic curve model.
LANE_CURVE_MODEL_3D Third-degree curve model.
LANE_CURVE_MODEL_KIND_COUNT Number of ps_lane_curve_model_kind values.

ps_lane_marker_kind

Lane marker/boundary kinds.

Value Description
LANE_MARKER_INVALID Lane marker information is invalid.
LANE_MARKER_UNKNOWN Lane marker information is unknown.
LANE_MARKER_NOT_AVAILABLE Lane marker information is not available.
LANE_MARKER_NONE Lane does not have a marker/boundary line.
LANE_MARKER_SOLID Solid lane marker.
LANE_MARKER_DASHED Dashed lane marker.
LANE_MARKER_VIRTUAL Virtual/implied lane marker.
LANE_MARKER_DOTS Dotted lane marker.
LANE_MARKER_ROAD_EDGE Road-edge lane marker.
LANE_MARKER_DOUBLE_LINE Double-line lane marker.
LANE_MARKER_KIND_COUNT Number of ps_lane_marker_kind values.

ps_object_classification_kind

Object classification kinds.

Value Description
OBJECT_CLASSIFICATION_INVALID Object classification information is invalid.
OBJECT_CLASSIFICATION_UNKNOWN Object classification information is unknown.
OBJECT_CLASSIFICATION_NOT_AVAILABLE Classification information on the object is not available.
OBJECT_CLASSIFICATION_UNCLASSIFIED Object is unclassified but seen.
OBJECT_CLASSIFICATION_UNDECIDED_SMALL Object is classified as unknown small.
OBJECT_CLASSIFICATION_UNDECIDED_BIG Object is classified as unknown big.
OBJECT_CLASSIFICATION_BARRIER Object is classified as a barrier.
OBJECT_CLASSIFICATION_PEDESTRIAN Object is classified as a pedestrian.
OBJECT_CLASSIFICATION_BIKE Object is classified as a bike.
OBJECT_CLASSIFICATION_CAR Object is classified as a car.
OBJECT_CLASSIFICATION_TRUCK Object is classified as a truck.
OBJECT_CLASSIFICATION_KIND_COUNT Number of ps_object_classification_kind values.

ps_quality_kind

Quality kinds.

Value Description
QUALITY_INVALID Quality information is invalid.
QUALITY_UNKNOWN Quality information is unknown.
QUALITY_NOT_AVAILABLE Quality information is not available.
QUALITY_0 Quality zero, lowest quality.
QUALITY_1 Quality one.
QUALITY_2 Quality two.
QUALITY_3 Quality three.
QUALITY_4 Quality four.
QUALITY_5 Quality five.
QUALITY_6 Quality six.
QUALITY_7 Quality seven.
QUALITY_8 Quality eight.
QUALITY_9 Quality nine, highest quality.
QUALITY_KIND_COUNT Number of ps_quality_kind values.

ps_range_kind

Range kinds.

Value Description
RANGE_INVALID Range information is invalid.
RANGE_UNKNOWN Range information is unknown.
RANGE_NOT_AVAILABLE Range information is not available.
RANGE_NONE Not in-range.
RANGE_NEAR Near range.
RANGE_MEDIUM Medium range.
RANGE_LONG Long range.
RANGE_KIND_COUNT Number of ps_range_kind values.

ps_supplementary_sign_kind

Supplementary sign kinds.

Value Description
SUPPLEMENTARY_SIGN_INVALID Supplementary sign information is invalid.
SUPPLEMENTARY_SIGN_UNKNOWN Supplementary sign information is unknown.
SUPPLEMENTARY_SIGN_NOT_AVAILABLE Supplementary sign information is not available.
SUPPLEMENTARY_SIGN_RAIN Rain.
SUPPLEMENTARY_SIGN_SNOW Snow.
SUPPLEMENTARY_SIGN_TRAILER Trailer.
SUPPLEMENTARY_SIGN_TIME Time.
SUPPLEMENTARY_SIGN_ARROW_LEFT Left arrow.
SUPPLEMENTARY_SIGN_ARROW_RIGHT Right arrow.
SUPPLEMENTARY_SIGN_BEND_ARROW_LEFT Left bent arrow.
SUPPLEMENTARY_SIGN_BEND_ARROW_RIGHT Right bent arrow.
SUPPLEMENTARY_SIGN_TRUCK Truck.
SUPPLEMENTARY_SIGN_DISTANCE_ARROW Distance arrow, restriction is for x kilometers.
SUPPLEMENTARY_SIGN_WEIGHT Weight.
SUPPLEMENTARY_SIGN_DISTANCE_IN Distance in, restriction in x meters.
SUPPLEMENTARY_SIGN_TRACTOR Tractor.
SUPPLEMENTARY_SIGN_SNOW_RAIN Snow/rain.
SUPPLEMENTARY_SIGN_SCHOOL School.
SUPPLEMENTARY_SIGN_RAIN_CLOUD Rain cloud.
SUPPLEMENTARY_SIGN_FOG Fog.
SUPPLEMENTARY_SIGN_HAZARDOUS_MATERIALS Hazardous materials.
SUPPLEMENTARY_SIGN_NIGHT Night.
SUPPLEMENTARY_SIGN_RAPPEL Rappel.
SUPPLEMENTARY_SIGN_E_ZONE Zone word below the sign.
SUPPLEMENTARY_SIGN_KIND_COUNT Number of ps_supplementary_sign_kind values.

ps_track_status_kind

Track status kinds.

Value Description
TRACK_STATUS_INVALID Track status information is invalid.
TRACK_STATUS_UNKNOWN Track status information is unknown.
TRACK_STATUS_NOT_AVAILABLE Status information on the track is not available.
TRACK_STATUS_NO_TRACK Track is not valid and should not be considered usable.
TRACK_STATUS_RAW_TARGET Track is a raw target measurement and is not tracked.
TRACK_STATUS_ACTIVE Track is active/valid.
TRACK_STATUS_CIPV Track is flagged as the closest in path vehicle.
TRACK_STATUS_NEW Track is new to the tracker, i.e. the start of a track.
TRACK_STATUS_NEW_UPDATED Track is new and was updated.
TRACK_STATUS_UPDATED Track was updated.
TRACK_STATUS_COASTED Track was coasted.
TRACK_STATUS_MERGED Track was merged.
TRACK_STATUS_INVALID_COASTED Track is invalid and was coasted.
TRACK_STATUS_NEW_COASTED Track is new and was coasted.
TRACK_STATUS_KIND_COUNT Number of ps_track_status_kind values.

ps_traffic_sign_kind

Traffic sign kinds.

Value Description
TRAFFIC_SIGN_INVALID Traffic sign information is invalid.
TRAFFIC_SIGN_UNKNOWN Traffic sign information is unknown.
TRAFFIC_SIGN_NOT_AVAILABLE Traffic sign information is not available.
TRAFFIC_SIGN_REG_10 Standard regular 10.
TRAFFIC_SIGN_REG_20 Standard regular 20.
TRAFFIC_SIGN_REG_30 Standard regular 30.
TRAFFIC_SIGN_REG_40 Standard regular 40.
TRAFFIC_SIGN_REG_50 Standard regular 50.
TRAFFIC_SIGN_REG_60 Standard regular 60.
TRAFFIC_SIGN_REG_70 Standard regular 70.
TRAFFIC_SIGN_REG_80 Standard regular 80.
TRAFFIC_SIGN_REG_90 Standard regular 90.
TRAFFIC_SIGN_REG_100 Standard regular 100.
TRAFFIC_SIGN_REG_110 Standard regular 110.
TRAFFIC_SIGN_REG_120 Standard regular 120.
TRAFFIC_SIGN_REG_130 Standard regular 130.
TRAFFIC_SIGN_REG_140 Standard regular 140.
TRAFFIC_SIGN_REG_END_RESTRICT_NUM Standard regular end restriction of number.
TRAFFIC_SIGN_ELE_10 Standard electronic 10.
TRAFFIC_SIGN_ELE_20 Standard electronic 20.
TRAFFIC_SIGN_ELE_30 Standard electronic 30.
TRAFFIC_SIGN_ELE_40 Standard electronic 40.
TRAFFIC_SIGN_ELE_50 Standard electronic 50.
TRAFFIC_SIGN_ELE_60 Standard electronic 60.
TRAFFIC_SIGN_ELE_70 Standard electronic 70.
TRAFFIC_SIGN_ELE_80 Standard electronic 80.
TRAFFIC_SIGN_ELE_90 Standard electronic 90.
TRAFFIC_SIGN_ELE_100 Standard electronic 100.
TRAFFIC_SIGN_ELE_110 Standard electronic 110.
TRAFFIC_SIGN_ELE_120 Standard electronic 120.
TRAFFIC_SIGN_ELE_130 Standard electronic 130.
TRAFFIC_SIGN_ELE_140 Standard electronic 140.
TRAFFIC_SIGN_ELE_END_RESTRICT_NUM Standard electronic end restriction of number.
TRAFFIC_SIGN_REG_END_RESTRICT_ALL Standard regular general end all restriction.
TRAFFIC_SIGN_ELE_END_RESTRICT_ALL Standard electronic general end all restriction.
TRAFFIC_SIGN_REG_5 Standard regular 5.
TRAFFIC_SIGN_REG_15 Standard regular 15.
TRAFFIC_SIGN_REG_25 Standard regular 25.
TRAFFIC_SIGN_REG_35 Standard regular 35.
TRAFFIC_SIGN_REG_45 Standard regular 45.
TRAFFIC_SIGN_REG_55 Standard regular 55.
TRAFFIC_SIGN_REG_65 Standard regular 65.
TRAFFIC_SIGN_REG_75 Standard regular 75.
TRAFFIC_SIGN_REG_85 Standard regular 85.
TRAFFIC_SIGN_REG_95 Standard regular 95.
TRAFFIC_SIGN_REG_105 Standard regular 105.
TRAFFIC_SIGN_REG_115 Standard regular 115.
TRAFFIC_SIGN_REG_125 Standard regular 125.
TRAFFIC_SIGN_REG_135 Standard regular 135.
TRAFFIC_SIGN_REG_145 Standard regular 145.
TRAFFIC_SIGN_ELE_5 Standard electronic 5.
TRAFFIC_SIGN_ELE_15 Standard electronic 15.
TRAFFIC_SIGN_ELE_25 Standard electronic 25.
TRAFFIC_SIGN_ELE_35 Standard electronic 35.
TRAFFIC_SIGN_ELE_45 Standard electronic 45.
TRAFFIC_SIGN_ELE_55 Standard electronic 55.
TRAFFIC_SIGN_ELE_65 Standard electronic 65.
TRAFFIC_SIGN_ELE_75 Standard electronic 75.
TRAFFIC_SIGN_ELE_85 Standard electronic 85.
TRAFFIC_SIGN_ELE_95 Standard electronic 95.
TRAFFIC_SIGN_ELE_105 Standard electronic 105.
TRAFFIC_SIGN_ELE_115 Standard electronic 115.
TRAFFIC_SIGN_ELE_125 Standard electronic 125.
TRAFFIC_SIGN_ELE_135 Standard electronic 135.
TRAFFIC_SIGN_ELE_145 Standard electronic 145.
TRAFFIC_SIGN_REG_BEGIN_MOTORWAY Standard regular begin of motorway.
TRAFFIC_SIGN_REG_END_MOTORWAY Standard regular end of motorway.
TRAFFIC_SIGN_REG_BEGIN_EXPRESSWAY Standard regular begin of expressway.
TRAFFIC_SIGN_REG_END_EXPRESSWAY Standard regular end of expressway.
TRAFFIC_SIGN_REG_BEGIN_PLAYGROUND_AREA Standard regular begin of playground area.
TRAFFIC_SIGN_REG_END_PLAYGROUND_AREA Standard regular end of playground area.
TRAFFIC_SIGN_REG_BEGIN_NO_PASSING Standard regular begin of no passing area.
TRAFFIC_SIGN_REG_END_NO_PASSING Standard regular end of no passing area.
TRAFFIC_SIGN_ELE_BEGIN_NO_PASSING Standard electronic begin of no passing area.
TRAFFIC_SIGN_ELE_END_NO_PASSING Standard electronic end of no passing area.
TRAFFIC_SIGN_KIND_COUNT Number of ps_traffic_sign_kind values.

ps_traffic_sign_unit_kind

Traffic sign unit kinds.

Value Description
TRAFFIC_SIGN_UNIT_INVALID Traffic sign unit information is invalid.
TRAFFIC_SIGN_UNIT_UNKNOWN Traffic sign unit information is unknown.
TRAFFIC_SIGN_UNIT_NOT_AVAILABLE Traffic sign unit information is not available.
TRAFFIC_SIGN_UNIT_MPH Traffic sign units are in miles per hour.
TRAFFIC_SIGN_UNIT_KPH Traffic sign units are in kilometers per hour.
TRAFFIC_SIGN_UNIT_KIND_COUNT Number of ps_traffic_sign_unit_kind values.

ps_zone_kind

Zone kinds.

Value Description
ZONE_INVALID Zone information is invalid.
ZONE_UNKNOWN Zone information is unknown.
ZONE_NOT_AVAILABLE Zone information is not available.
ZONE_0 Zero to less than twenty percent of range.
ZONE_1 Twenty to less than forty percent of range.
ZONE_2 Forty to less than sixty percent of range.
ZONE_3 Sixty to less than eighty percent of range.
ZONE_4 Eighty to one hundred percent of range.
ZONE_KIND_COUNT Number of ps_zone_kind values.