TCourse Class Reference

#include <lbsposition.h>

Link against: lbs.lib

class TCourse

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

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()

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

iCourse

TReal32

iCourse

[protected]

True Course, in degrees.

iCourseAccuracy

TReal32

iCourseAccuracy

[protected]

Course accuracy, in degrees.

iHeading

TReal32

iHeading

[protected]

True Heading, in degrees.

iHeadingAccuracy

TReal32

iHeadingAccuracy

[protected]

Heading accuracy, in degrees.

iSpeed

TReal32

iSpeed

[protected]

Speed, in metres per second.

iSpeedAccuracy

TReal32

iSpeedAccuracy

[protected]

Speed accuracy, in metres per second.

iVerticalSpeed

TReal32

iVerticalSpeed

[protected]

Vertical Speed, in metres per second.

iVerticalSpeedAccuracy

TReal32

iVerticalSpeedAccuracy

[protected]

Vertical Speed accuracy, in metres per second.

Constructor & Destructor Documentation

TCourse ( )

IMPORT_C

TCourse

(

)

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

Member Function Documentation

Course ( )

IMPORT_C TReal32

Course

(

)

const

Retrieves the true course over ground.

Return Value: the true course over ground, in degrees.

CourseAccuracy ( )

IMPORT_C TReal32

CourseAccuracy

(

)

const

Retrieves the accuracy of the course over ground.

Return Value: the accuracy of the course over ground, in degrees.

Heading ( )

IMPORT_C TReal32

Heading

(

)

const

Retrieves the true heading of this course.

Return Value: the true heading, in degrees.

HeadingAccuracy ( )

IMPORT_C TReal32

HeadingAccuracy

(

)

const

Retrieves the accuracy of the heading component of this course.

Return Value: the accuracy of the heading, in degrees.

SetCourse ( TReal32 )

IMPORT_C void

SetCourse

(

TReal32

aCourse

)

Changes the true course over ground.

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

Parameters
aCourseAccuracy	is the new accuracy of the course, in degrees.

Panic Codes
"Lbs	Client Fault" 13 if aCourseAccuracy is negative.

SetHeading ( TReal32 )

IMPORT_C void

SetHeading

(

TReal32

aHeading

)

Changes the true heading of this course.

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

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

Panic Codes
aHeadingAccuracy	is negative.

SetSpeed ( TReal32 )

IMPORT_C void

SetSpeed

(

TReal32

aSpeed

)

Changes the speed of this course.

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

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

Panic Codes
aSpeedAccuracy	is negative.

SetVerticalSpeed ( TReal32 )

IMPORT_C void

SetVerticalSpeed

(

TReal32

aVerticalSpeed

)

Changes the vertical speed of this course.

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

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

Panic Codes
aVerticalSpeedAccuracy	is negative.

Speed ( )

IMPORT_C TReal32

Speed

(

)

const

Retrieves the speed of this course.

Return Value: the speed, in metres per second.

SpeedAccuracy ( )

IMPORT_C TReal32

SpeedAccuracy

(

)

const

Retrieves the accuracy of the speed component of this course.

Return Value: the accuracy of the speed, in metres per second.

VerticalSpeed ( )

IMPORT_C TReal32

VerticalSpeed

(

)

const

Retrieves the vertical speed of this course.

Return Value: the vertical speed, in metres per second.

VerticalSpeedAccuracy ( )

IMPORT_C TReal32

VerticalSpeedAccuracy

(

)

const

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

Return Value: the accuracy of the vertical speed, in metres per second.