Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <LbsPosition.h>
Link against: lbs.lib
Link against: lbsselflocate.lib

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:


Construction and destruction


TCourse()

IMPORT_C TCourse();

Description

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

[Top]


Member functions


Speed()const

IMPORT_C TReal32 Speed() const;

Description

Retrieves the speed of this course.

Return value

TReal32

the speed, in metres per second.


Heading()const

IMPORT_C TReal32 Heading() const;

Description

Retrieves the heading of this course.

Return value

TReal32

the heading, in degrees.


Course()const

IMPORT_C TReal32 Course() const;

Description

Retrieves the course over ground.

Return value

TReal32

the course over ground, in degrees.


SpeedAccuracy()const

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.


HeadingAccuracy()const

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.


CourseAccuracy()const

IMPORT_C TReal32 CourseAccuracy() const;

Description

Retrieves the accuracy of the course over ground.

Return value

TReal32

the accuracy of the course over ground, in degrees.


SetSpeed(TReal32)

IMPORT_C void SetSpeed(TReal32 aSpeed);

Description

Changes the speed of this course.

Parameters

TReal32 aSpeed

is the new speed, in metres per second.


SetHeading(TReal32)

IMPORT_C void SetHeading(TReal32 aHeading);

Description

Changes the heading of this course.

Parameters

TReal32 aHeading

is the new heading, in degrees.


SetSpeedAccuracy(TReal32)

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.


SetHeadingAccuracy(TReal32)

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.


SetCourse(TReal32)

IMPORT_C void SetCourse(TReal32 aCourse);

Description

Changes the course over ground.

Parameters

TReal32 aCourse

is the new course, in degrees.


SetCourseAccuracy(TReal32)

IMPORT_C void SetCourseAccuracy(TReal32 aCourseAccuracy);

Description

Changes the accuracy of the course component of this course.

Parameters

TReal32 aCourseAccuracy

is the new accuracy of the course, in degrees.

Panic codes

"Lbs

Client Fault" 13 if aCourseAccuracy is negative.

[Top]


Member data


iSpeed

protected: TReal32 iSpeed;

Description

Speed, in metres per second.


iHeading

protected: TReal32 iHeading;

Description

Heading, in degrees.


iSpeedAccuracy

protected: TReal32 iSpeedAccuracy;

Description

Speed accuracy, in metres per second.


iHeadingAccuracy

protected: TReal32 iHeadingAccuracy;

Description

Heading accuracy, in degrees.


iCourse

protected: TReal32 iCourse;

Description

Course, in degrees.


iCourseAccuracy

protected: TReal32 iCourseAccuracy;

Description

Course accuracy, in degrees.