Class TCourse

class TCourse;

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.

Members

Defined in TCourse:
Heading(), HeadingAccuracy(), SetHeading(), SetHeadingAccuracy(), SetSpeed(), SetSpeedAccuracy(), Speed(), SpeedAccuracy(), TCourse(), iHeading, iHeadingAccuracy, iSpeed, iSpeedAccuracy

IMPORT_C TCourse();

Description

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

IMPORT_C TReal32 Speed() const;

Description

Retrieves the speed of this course.

Return value

TReal32 the speed, in metres per second.

IMPORT_C TReal32 Heading() const;

Description

Retrieves the heading of this course.

Return value

TReal32 the heading, in degrees.

IMPORT_C TReal32 SpeedAccuracy() const;

Description

Retrieves the accuracy of the speed component of this course.

Return value

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

IMPORT_C TReal32 HeadingAccuracy() const;

Description

Retrieves the accuracy of the heading component of this course.

Return value

TReal32 the accuracy of the heading, in degrees.

IMPORT_C void SetSpeed(TReal32 aSpeed);

Description

Changes the speed of this course.

Parameters

TReal32 aSpeed is the new speed, in metres per second.

IMPORT_C void SetHeading(TReal32 aHeading);

Description

Changes the heading of this course.

Parameters

TReal32 aHeading is the new heading, in degrees.

IMPORT_C void SetSpeedAccuracy(TReal32 aSpeedAccuracy);

Description

Changes the accuracy of the speed component of this course.

Parameters

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

Panic codes

aSpeedAccuracy is negative.

IMPORT_C void SetHeadingAccuracy(TReal32 aHeadingAccuracy);

Description

Changes the accuracy of the heading component of this course.

Parameters

TReal32 aHeadingAccuracy is the new accuracy of the heading, in degrees.

Panic codes

aHeadingAccuracy is negative.

protected: TReal32 iSpeed;

Description

Speed, in metres per second.

protected: TReal32 iHeading;

Description

Heading, in degrees.

protected: TReal32 iSpeedAccuracy;

Description

Speed accuracy, in metres per second.

protected: TReal32 iHeadingAccuracy;

Description

Heading accuracy, in degrees.