TCourse Class Reference
Detailed Description
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.
Member Attribute Documentation
iCourseAccuracy
Course accuracy, in degrees.
iHeading
True Heading, in degrees.
iHeadingAccuracy
|
TReal32
| iHeadingAccuracy | [protected] |
Heading accuracy, in degrees.
iSpeed
Speed, in metres per second.
iSpeedAccuracy
Speed accuracy, in metres per second.
iVerticalSpeed
Vertical Speed, in metres per second.
iVerticalSpeedAccuracy
|
TReal32
| iVerticalSpeedAccuracy | [protected] |
Vertical Speed accuracy, in metres per second.
Constructor & Destructor Documentation
TCourse ( )
Default constructor for TCourse. Sets the member data to default values (NaN).
Member Function Documentation
Course ( )
Retrieves the true course over ground.
Returns: the true course over ground, in degrees.
CourseAccuracy ( )
| IMPORT_C TReal32 | CourseAccuracy | ( | ) | const |
Retrieves the accuracy of the course over ground.
Returns: the accuracy of the course over ground, in degrees.
Heading ( )
Retrieves the true heading of this course.
Returns: the true heading, in degrees.
HeadingAccuracy ( )
| IMPORT_C TReal32 | HeadingAccuracy | ( | ) | const |
Retrieves the accuracy of the heading component of this course.
Returns: the accuracy of the heading, in degrees.
SetCourse ( TReal32 )
| IMPORT_C void | SetCourse | ( | TReal32 | aCourse | ) | |
Changes the true course over ground.
| Parameter | Description | | aCourse | is the new true course, in degrees. |
SetCourseAccuracy ( TReal32 )
| IMPORT_C void | SetCourseAccuracy | ( | TReal32 | aCourseAccuracy | ) | |
Changes the accuracy of the course component of this course.
- panic
- "Lbs Client Fault" 13 if aCourseAccuracy is negative.
| Parameter | Description | | aCourseAccuracy | is the new accuracy of the course, in degrees. |
SetHeading ( TReal32 )
| IMPORT_C void | SetHeading | ( | TReal32 | aHeading | ) | |
Changes the true heading of this course.
| Parameter | Description | | aHeading | is the new true heading, in degrees. |
SetHeadingAccuracy ( TReal32 )
| IMPORT_C void | SetHeadingAccuracy | ( | TReal32 | aHeadingAccuracy | ) | |
Changes the accuracy of the heading component of this course.
-
panic
- aHeadingAccuracy is negative.
| Parameter | Description | | aHeadingAccuracy | is the new accuracy of the heading, in degrees. |
SetSpeed ( TReal32 )
| IMPORT_C void | SetSpeed | ( | TReal32 | aSpeed | ) | |
Changes the speed of this course.
| Parameter | Description | | aSpeed | is the new speed, in metres per second. |
SetSpeedAccuracy ( TReal32 )
| IMPORT_C void | SetSpeedAccuracy | ( | TReal32 | aSpeedAccuracy | ) | |
Changes the accuracy of the speed component of this course.
-
panic
- aSpeedAccuracy is negative.
| Parameter | Description | | aSpeedAccuracy | is the new accuracy of the speed, in metres per second. |
SetVerticalSpeed ( TReal32 )
| IMPORT_C void | SetVerticalSpeed | ( | TReal32 | aVerticalSpeed | ) | |
Changes the vertical speed of this course.
| Parameter | Description | | aVerticalSpeed | is the new vertical speed, in metres per second. |
SetVerticalSpeedAccuracy ( TReal32 )
| IMPORT_C void | SetVerticalSpeedAccuracy | ( | TReal32 | aVerticalSpeedAccuracy | ) | |
Changes the accuracy of the speed component of this course.
-
panic
- aVerticalSpeedAccuracy is negative.
| Parameter | Description | | aVerticalSpeedAccuracy | is the new accuracy of the vertical speed, in metres per second. |
Speed ( )
Retrieves the speed of this course.
Returns: the speed, in metres per second.
SpeedAccuracy ( )
| IMPORT_C TReal32 | SpeedAccuracy | ( | ) | const |
Retrieves the accuracy of the speed component of this course.
Returns: the accuracy of the speed, in metres per second.
VerticalSpeed ( )
| IMPORT_C TReal32 | VerticalSpeed | ( | ) | const |
Retrieves the vertical speed of this course.
Returns: the vertical speed, in metres per second.
VerticalSpeedAccuracy ( )
| IMPORT_C TReal32 | VerticalSpeedAccuracy | ( | ) | const |
Retrieves the accuracy of the vertical speed component of this course.
Returns: the accuracy of the vertical speed, in metres per second.