CrossTrackError Property

Returns the cross track error and direction to steer to correct.

Syntax

Visual Basic

object.CrossTrackError

Visual C++

object.GetCrossTrackError()

Example

Visual Basic

Dim crossTrackError As String

'Get cross track error
crossTrackError = myGPSToolKit.CrossTrackError

Visual C++

_variant_t vtCrossTrackError;

// Get cross track error
vtCrossTrackError = m_myGPSToolKit.GetCrossTrackError();
CString strCrossTrackError = (BSTR)(_bstr_t)vtCrossTrackError;

Remarks

CrossTrackError indicates difference in nautical miles between the current GPS position and the line connecting the origin and destination waypoints, and which direction to steer to correct the difference. This value is always reported in nautical miles and is not affected by the DistUnits property.

Default

Empty (VT_EMPTY)

Returns

A VARIANT (type VT_BSTR/BSTR/VB String) containing the last reported cross track error in nautical miles and the direction in which to steer to return to the proscribed course (L = steer left, R = steer right). If no cross track error data is reported the variable will be empty (type VT_EMPTY).

Errors

None

See Also