S60 3rd Edition API Reference: TCourse Class Reference

TCourse Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbsposition.h>

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.


Public Member Functions

IMPORT_C TCourse ()
 Default constructor for TCourse.
IMPORT_C TReal32 Speed () const
 Retrieves the speed.
IMPORT_C TReal32 Heading () const
 Retrieves the heading.
IMPORT_C TReal32 Course () const
 Retrieves the course over ground.
IMPORT_C TReal32 SpeedAccuracy () const
 Retrieves the accuracy of the speed component.
IMPORT_C TReal32 HeadingAccuracy () const
 Retrieves the accuracy of the heading component.
IMPORT_C TReal32 CourseAccuracy () const
 Retrieves the accuracy of the course over ground.
IMPORT_C void SetSpeed (TReal32 aSpeed)
 Changes the speed of this course.
IMPORT_C void SetHeading (TReal32 aHeading)
 Changes the heading of this course.
IMPORT_C void SetSpeedAccuracy (TReal32 aSpeedAccuracy)
 Changes the accuracy of the speed component of this course.
IMPORT_C void SetHeadingAccuracy (TReal32 aHeadingAccuracy)
 Changes the accuracy of the heading component of this course.
IMPORT_C void SetCourse (TReal32 aCourse)
 Changes the course over ground.
IMPORT_C void SetCourseAccuracy (TReal32 aCourseAccuracy)
 Changes the accuracy of the course component of this course.

Protected Attributes

TReal32 iSpeed
 Speed, in metres per second.
TReal32 iHeading
 Heading, in degrees.
TReal32 iSpeedAccuracy
 Speed accuracy, in metres per second.
TReal32 iHeadingAccuracy
 Heading accuracy, in degrees.
TReal32 iCourse
 Course, in degrees.
TReal32 iCourseAccuracy
 Course accuracy, in degrees.

Constructor & Destructor Documentation

IMPORT_C TCourse::TCourse (   ) 
 

Default constructor for TCourse.

Sets the member data to default values (NaN).

Member Function Documentation

IMPORT_C TReal32 TCourse::Course (   )  const
 

Retrieves the course over ground.

Returns:
the course over ground, in degrees.
IMPORT_C TReal32 TCourse::CourseAccuracy (   )  const
 

Retrieves the accuracy of the course over ground.

Returns:
the accuracy of the course over ground, in degrees.
IMPORT_C TReal32 TCourse::Heading (   )  const
 

Retrieves the heading.

Returns:
the heading, in degrees.
IMPORT_C TReal32 TCourse::HeadingAccuracy (   )  const
 

Retrieves the accuracy of the heading component.

Returns:
the accuracy of the heading, in degrees.
IMPORT_C void TCourse::SetCourse ( TReal32  aCourse  ) 
 

Changes the course over ground.

Parameters:
aCourse is the new course, in degrees.
IMPORT_C void TCourse::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:
"Lbs Client Fault" 13 if aCourseAccuracy is negative.
IMPORT_C void TCourse::SetHeading ( TReal32  aHeading  ) 
 

Changes the heading of this course.

Parameters:
aHeading is the new heading, in degrees.
IMPORT_C void TCourse::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:
"Lbs Client Fault" 13 if aHeadingAccuracy is negative.
IMPORT_C void TCourse::SetSpeed ( TReal32  aSpeed  ) 
 

Changes the speed of this course.

Parameters:
aSpeed is the new speed, in metres per second.
IMPORT_C void TCourse::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:
"Lbs Client Fault" 13 if aSpeedAccuracy is negative.
IMPORT_C TReal32 TCourse::Speed (   )  const
 

Retrieves the speed.

Returns:
the speed, in metres per second.
IMPORT_C TReal32 TCourse::SpeedAccuracy (   )  const
 

Retrieves the accuracy of the speed component.

Returns:
the accuracy of the speed, in metres per second.

Field Documentation

TReal32 TCourse::iCourse [protected]
 

Course, in degrees.

TReal32 TCourse::iCourseAccuracy [protected]
 

Course accuracy, in degrees.

TReal32 TCourse::iHeading [protected]
 

Heading, in degrees.

TReal32 TCourse::iHeadingAccuracy [protected]
 

Heading accuracy, in degrees.

TReal32 TCourse::iSpeed [protected]
 

Speed, in metres per second.

TReal32 TCourse::iSpeedAccuracy [protected]
 

Speed accuracy, in metres per second.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top