Collapse all Symbian^3 Application Developer Library

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.

Public Member Functions
	TCourse ()
IMPORT_C TReal32	Course ()
IMPORT_C TReal32	CourseAccuracy ()
IMPORT_C TReal32	Heading ()
IMPORT_C TReal32	HeadingAccuracy ()
IMPORT_C void	SetCourse ( TReal32 )
IMPORT_C void	SetCourseAccuracy ( TReal32 )
IMPORT_C void	SetHeading ( TReal32 )
IMPORT_C void	SetHeadingAccuracy ( TReal32 )
IMPORT_C void	SetSpeed ( TReal32 )
IMPORT_C void	SetSpeedAccuracy ( TReal32 )
IMPORT_C void	SetVerticalSpeed ( TReal32 )
IMPORT_C void	SetVerticalSpeedAccuracy ( TReal32 )
IMPORT_C TReal32	Speed ()
IMPORT_C TReal32	SpeedAccuracy ()
IMPORT_C TReal32	VerticalSpeed ()
IMPORT_C TReal32	VerticalSpeedAccuracy ()

Protected Attributes
TReal32	iCourse
TReal32	iCourseAccuracy
TReal32	iHeading
TReal32	iHeadingAccuracy
TReal32	iSpeed
TReal32	iSpeedAccuracy
TReal32	iVerticalSpeed
TReal32	iVerticalSpeedAccuracy

Private Attributes
TUint8	iReserved

Constructor & Destructor Documentation

TCourse()

IMPORT_C

TCourse

(

)

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

Member Functions Documentation

Course()

IMPORT_C TReal32

Course

(

)

const

Retrieves the true course over ground.

CourseAccuracy()

IMPORT_C TReal32

CourseAccuracy

(

)

const

Retrieves the accuracy of the course over ground.

Heading()

IMPORT_C TReal32

Heading

(

)

const

Retrieves the true heading of this course.

HeadingAccuracy()

IMPORT_C TReal32

HeadingAccuracy

(

)

const

Retrieves the accuracy of the heading component of this course.

SetCourse(TReal32)

IMPORT_C void

SetCourse

(

TReal32

aCourse

)

Changes the true course over ground.

Parameters

TReal32 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.

Parameters

TReal32 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.

Parameters

TReal32 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.

Parameters

TReal32 aHeadingAccuracy

is the new accuracy of the heading, in degrees.

SetSpeed(TReal32)

IMPORT_C void

SetSpeed

(

TReal32

aSpeed

)

Changes the speed of this course.

Parameters

TReal32 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.

Parameters

TReal32 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.

Parameters

TReal32 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.

Parameters

TReal32 aVerticalSpeedAccuracy

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

Speed()

IMPORT_C TReal32

Speed

(

)

const

Retrieves the speed of this course.

SpeedAccuracy()

IMPORT_C TReal32

SpeedAccuracy

(

)

const

Retrieves the accuracy of the speed component of this course.

VerticalSpeed()

IMPORT_C TReal32

VerticalSpeed

(

)

const

Retrieves the vertical speed of this course.

VerticalSpeedAccuracy()

IMPORT_C TReal32

VerticalSpeedAccuracy

(

)

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.