test: epoc32/include/lbsposition.h@837f303aceeb

     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #ifndef __LBSPOSITION_H__

    17 #define __LBSPOSITION_H__

    19 #include <e32std.h>

    20 #include <lbsvariant.h>

    22 /**

    23 @publishedAll

    24 @released

    25 Datum IDs

    26  */

    27 typedef TUid TPositionDatumId;

    30 /**

    31 @publishedAll

    32 @released

    33 Constant for the co-ordinate system for GPS system

    34  */

    35 const TPositionDatumId KPositionDatumWgs84 = {0x101FAA29};

    37 class TCoordinate

    38 /**

    39 TCoordinate is used to hold the basic coordinates of a location (latitude,

    40 longitude and altitude).

    42 @publishedAll

    43 @released

    44  */

    45 	{

    46 public:

    47 	IMPORT_C TCoordinate();

    48 	IMPORT_C TCoordinate(const TReal64& aLatitude,

    49 	                     const TReal64& aLongitude);

    50 	IMPORT_C TCoordinate(const TReal64& aLatitude,

    51 	                     const TReal64& aLongitude,

    52 	                     TReal32 aAltitude);

    54 	IMPORT_C void SetCoordinate(const TReal64& aLatitude,

    55 	                            const TReal64& aLongitude);

    56 	IMPORT_C void SetCoordinate(const TReal64& aLatitude,

    57 	                            const TReal64& aLongitude,

    58 	                            TReal32 aAltitude);

    60 	IMPORT_C void SetDatum(TPositionDatumId aDatum);

    62 	IMPORT_C TReal64 Latitude() const;

    63 	IMPORT_C TReal64 Longitude() const;

    64 	IMPORT_C TReal32 Altitude() const;

    65 	IMPORT_C TPositionDatumId Datum() const;

    67 	IMPORT_C TInt Distance(const TCoordinate& aCoordinate,

    68 	                       TReal32& aDistance) const;

    69 	IMPORT_C TInt BearingTo(const TCoordinate& aTargetCoordinate,

    70 	                        TReal32& aBearing) const;

    72 	IMPORT_C TInt Move(TReal32 aBearing, TReal32 aDistance);

    74 private:

    75 	void NormalizeCoordinate();

    77 protected:

    78 	/** Latitude, defaults to WGS-84 format. Represented in degree. */

    79 	TReal64 iLatitude;

    80 	/** Longitude, defaults to WGS-84 format. Represented in degree. */

    81 	TReal64 iLongitude;

    82 	/** Altitude, defaults to WGS-84 format. Represented in meters. */

    83 	TReal32 iAltitude;

    84 	/** The ID of the datum the coordinate is in, defaults to WGS-84 format. */

    85 	TPositionDatumId iDatum;

    86 	/** Unused variable for future expansion. */

    87 	TUint8 iReserved[4];

    88 	};

    91 class TLocality : public TCoordinate

    92 /**

    93 Adds an error estimate for the horizontal and vertical accuracy of the point

    94 to TCoordinate. Accuracy information is held in a TReal32 and is measure in

    95 metres. The class also provides its own methods for determining the distance

    96 and bearing to a target point. These methods also provide an error estimate.

    98 @publishedAll

    99 @released

   100  */

   101 	{

   102 public:

   103 	IMPORT_C TLocality();

   104 	IMPORT_C TLocality(const TCoordinate& aCoordinate,

   105 	                   TReal32 aHorizontalAccuracy);

   106 	IMPORT_C TLocality(const TCoordinate& aCoordinate,

   107 	                   TReal32 aHorizontalAccuracy,

   108 	                   TReal32 aVerticalAccuracy);

   110 	IMPORT_C void SetHorizontalAccuracy(TReal32 aHorizontalAccuracy);

   111 	IMPORT_C void SetVerticalAccuracy(TReal32 aVerticalAccuracy);

   112 	IMPORT_C void SetAccuracy(TReal32 aHorizontalAccuracy,

   113 	                          TReal32 aVerticalAccuracy);

   115 	IMPORT_C TReal32 HorizontalAccuracy() const;

   116 	IMPORT_C TReal32 VerticalAccuracy() const;

   118 	IMPORT_C TInt Distance(const TCoordinate& aCoordinate,

   119 	                       TReal32& aDistance) const;

   120 	IMPORT_C TInt Distance(const TLocality& aLocality,

   121 	                       TReal32& aDistance,

   122 	                       TReal32& aDelta) const;

   124 	IMPORT_C TInt BearingTo(const TCoordinate& aTargetCoordinate,

   125 	                        TReal32& aBearing) const;

   127 	IMPORT_C TInt BearingTo(const TLocality& aTargetLocality,

   128 	                        TReal32& aBearing,

   129 	                        TReal32& aDelta) const;

   131 protected:

   132 	/** Horizontal (earths-surface) accuracy, in metres. */

   133 	TReal32 iHorizontalAccuracy;

   134 	/** Altitudinal accuracy, in metres. */

   135 	TReal32 iVerticalAccuracy;

   137 private:

   138 	/** Unused variable for future expansion. */

   139 	TUint8 iReserved[16];

   140 	};

   143 class TPosition : public TLocality

   144 /**

   145 This class is the standard data structure for retrieving location

   146 information. It adds a time dimension to the inherited TLocality information.

   147 This enables the speed to be calculated from two TPosition instances.

   149 The time reflects the system time (that is, the mobile terminal) of when the

   150 location fix was obtained. It does not indicate the time as obtained from the

   151 position technology (for example network or satellite time).

   153 The time is contained in a TTime data structure that provides microsecond

   154 resolution. However, it should be noted that system clocks only provide a

   155 resolution of milliseconds or indeed hundredths of a second.

   157 @publishedAll

   158 @released

   159  */

   160 	{

   161 public:

   162 	IMPORT_C TPosition();

   163 	IMPORT_C TPosition(const TLocality& aLocality,

   164 	                   TTime aTime);

   166 	IMPORT_C void SetTime(TTime aTime);

   167 	IMPORT_C void SetCurrentTime();

   169 	IMPORT_C TTime Time() const;

   171 	IMPORT_C TInt Speed(const TPosition& aPosition,

   172 	                    TReal32& aSpeed) const;

   173 	IMPORT_C TInt Speed(const TPosition& aPosition,

   174 	                    TReal32& aSpeed,

   175 	                    TReal32& aDelta) const;

   177 protected:

   178 	/** This is the system time when the position related member data was

   179 	obtained. */

   180 	TTime iTime;

   182 private:

   183 	/** Unused variable for future expansion. */

   184 	TUint8 iReserved[16];

   185 	};

   188 class TCourse

   189 /**

   190 This is used to hold information about the current speed and direction

   191 of the device. It is generally used in conjunction with TPositionCourseInfo

   192 when a positioning technology is able to supply these details as part of

   193 its positioning information.

   195 @publishedAll

   196 @released

   197  */

   198 	{

   199 public:

   200 	IMPORT_C TCourse();

   202 	IMPORT_C TReal32 Speed() const;

   203 	IMPORT_C TReal32 VerticalSpeed() const;

   204 	IMPORT_C TReal32 Heading() const;

   205     IMPORT_C TReal32 Course() const;

   207     IMPORT_C TReal32 SpeedAccuracy() const;

   208     IMPORT_C TReal32 VerticalSpeedAccuracy() const;

   209     IMPORT_C TReal32 HeadingAccuracy() const;

   210     IMPORT_C TReal32 CourseAccuracy() const;

   213     IMPORT_C void SetSpeed(TReal32 aSpeed);

   214     IMPORT_C void SetVerticalSpeed(TReal32 aVerticalSpeed);

   215     IMPORT_C void SetHeading(TReal32 aHeading);

   216 	IMPORT_C void SetSpeedAccuracy(TReal32 aSpeedAccuracy);

   217 	IMPORT_C void SetVerticalSpeedAccuracy(TReal32 aVerticalSpeedAccuracy);

   218 	IMPORT_C void SetHeadingAccuracy(TReal32 aHeadingAccuracy);

   219 	IMPORT_C void SetCourse(TReal32 aCourse);

   220 	IMPORT_C void SetCourseAccuracy(TReal32 aCourseAccuracy);

   225 protected:

   226 	/** Speed, in metres per second. */

   227 	TReal32 iSpeed;

   228 	/** True Heading, in degrees. */

   229 	TReal32 iHeading;

   230 	/** Speed accuracy, in metres per second. */

   231 	TReal32 iSpeedAccuracy;

   232 	/** Heading accuracy, in degrees. */

   233 	TReal32 iHeadingAccuracy;

   234 	/** True Course, in degrees. */

   235 	TReal32 iCourse;

   236 	/** Course accuracy, in degrees. */

   237 	TReal32 iCourseAccuracy;

   238 	/** Vertical Speed, in metres per second. */

   239 	TReal32 iVerticalSpeed;

   240 	/** Vertical Speed accuracy, in metres per second. */

   241 	TReal32 iVerticalSpeedAccuracy;

   243 private:

   244 	/** Unused variable for future expansion. */

   245 	TUint8 iReserved[8];

   246 	};

   248 #endif //__LBSPOSITION_H__

author	William Roberts <williamr@symbian.org>
	Wed, 31 Mar 2010 12:33:34 +0100
branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811
permissions	-rw-r--r--