CartoType C++ API 8.8-7-gb35e4dc71
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Public Attributes | List of all members
CartoTypeCore::LocationMatchParam Class Reference

#include <cartotype_navigation.h>

Public Member Functions

void Normalize ()
 
LocationMatchParam Normalized () const
 

Public Attributes

double LocationAccuracyInMeters = 0
 
double HeadingAccuracyInDegrees = 0
 
double MaxRoadDistanceInMeters = 0
 

Detailed Description

Parameters used when matching a road or other feature to a location.

Member Function Documentation

◆ Normalize()

void CartoTypeCore::LocationMatchParam::Normalize ( )

Converts zeros to default values and clamps other values to legal ranges.

◆ Normalized()

LocationMatchParam CartoTypeCore::LocationMatchParam::Normalized ( ) const
inline

Returns a normalized version of this object.

Member Data Documentation

◆ HeadingAccuracyInDegrees

double CartoTypeCore::LocationMatchParam::HeadingAccuracyInDegrees = 0

The accuracy of a heading or course given as an angular error in degrees with 95% probability. It is clamped to the range 1 ... 90. A value of zero indicates the default value: 22.5.

◆ LocationAccuracyInMeters

double CartoTypeCore::LocationMatchParam::LocationAccuracyInMeters = 0

The accuracy of a location fix given as a range error with 95% probability. It is clamped to the range 1 ... 1000. A value of zero indicates the default value: 8.

◆ MaxRoadDistanceInMeters

double CartoTypeCore::LocationMatchParam::MaxRoadDistanceInMeters = 0

The expected maximum distance of a road from the current location. It is clamped to the range 5 ... 10,000. A value of zero indicates the default value: 100.


The documentation for this class was generated from the following file: