TCourse Class Reference

class TCourse

This is used to hold information about the current speed and direction of the device. It is generally used in conjunction with TPositionCourseInfo when a positioning technology is able to supply these details as part of its positioning information.

Constructor & Destructor Documentation

TCourse()

IMPORT_CTCourse()

Default constructor for TCourse. Sets the member data to default values (NaN).

Member Functions Documentation

Course()

IMPORT_C TReal32Course()const

Retrieves the true course over ground.

CourseAccuracy()

IMPORT_C TReal32CourseAccuracy()const

Retrieves the accuracy of the course over ground.

Heading()

IMPORT_C TReal32Heading()const

Retrieves the true heading of this course.

HeadingAccuracy()

IMPORT_C TReal32HeadingAccuracy()const

Retrieves the accuracy of the heading component of this course.

SetCourse(TReal32)

IMPORT_C voidSetCourse(TReal32aCourse)

Changes the true course over ground.

Parameters

TReal32 aCourseis the new true course, in degrees.

SetCourseAccuracy(TReal32)

IMPORT_C voidSetCourseAccuracy(TReal32aCourseAccuracy)
Changes the accuracy of the course component of this course.
panic
"Lbs Client Fault" 13 if aCourseAccuracy is negative.

Parameters

TReal32 aCourseAccuracyis the new accuracy of the course, in degrees.

SetHeading(TReal32)

IMPORT_C voidSetHeading(TReal32aHeading)

Changes the true heading of this course.

Parameters

TReal32 aHeadingis the new true heading, in degrees.

SetHeadingAccuracy(TReal32)

IMPORT_C voidSetHeadingAccuracy(TReal32aHeadingAccuracy)

Changes the accuracy of the heading component of this course.

panic
aHeadingAccuracy is negative.

Parameters

TReal32 aHeadingAccuracyis the new accuracy of the heading, in degrees.

SetSpeed(TReal32)

IMPORT_C voidSetSpeed(TReal32aSpeed)

Changes the speed of this course.

Parameters

TReal32 aSpeedis the new speed, in metres per second.

SetSpeedAccuracy(TReal32)

IMPORT_C voidSetSpeedAccuracy(TReal32aSpeedAccuracy)

Changes the accuracy of the speed component of this course.

panic
aSpeedAccuracy is negative.

Parameters

TReal32 aSpeedAccuracyis the new accuracy of the speed, in metres per second.

SetVerticalSpeed(TReal32)

IMPORT_C voidSetVerticalSpeed(TReal32aVerticalSpeed)

Changes the vertical speed of this course.

Parameters

TReal32 aVerticalSpeedis the new vertical speed, in metres per second.

SetVerticalSpeedAccuracy(TReal32)

IMPORT_C voidSetVerticalSpeedAccuracy(TReal32aVerticalSpeedAccuracy)

Changes the accuracy of the speed component of this course.

panic
aVerticalSpeedAccuracy is negative.

Parameters

TReal32 aVerticalSpeedAccuracyis the new accuracy of the vertical speed, in metres per second.

Speed()

IMPORT_C TReal32Speed()const

Retrieves the speed of this course.

SpeedAccuracy()

IMPORT_C TReal32SpeedAccuracy()const

Retrieves the accuracy of the speed component of this course.

VerticalSpeed()

IMPORT_C TReal32VerticalSpeed()const

Retrieves the vertical speed of this course.

VerticalSpeedAccuracy()

IMPORT_C TReal32VerticalSpeedAccuracy()const

Retrieves the accuracy of the vertical speed component of this course.

Member Data Documentation

TReal32 iCourse

TReal32 iCourse[protected]

True Course, in degrees.

TReal32 iCourseAccuracy

TReal32 iCourseAccuracy[protected]

Course accuracy, in degrees.

TReal32 iHeading

TReal32 iHeading[protected]

True Heading, in degrees.

TReal32 iHeadingAccuracy

TReal32 iHeadingAccuracy[protected]

Heading accuracy, in degrees.

TUint8 iReserved

TUint8 iReserved[private]

Unused variable for future expansion.

TReal32 iSpeed

TReal32 iSpeed[protected]

Speed, in metres per second.

TReal32 iSpeedAccuracy

TReal32 iSpeedAccuracy[protected]

Speed accuracy, in metres per second.

TReal32 iVerticalSpeed

TReal32 iVerticalSpeed[protected]

Vertical Speed, in metres per second.

TReal32 iVerticalSpeedAccuracy

TReal32 iVerticalSpeedAccuracy[protected]

Vertical Speed accuracy, in metres per second.