1 /* |
|
2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Interface class for defining the engine. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef __MSATELLITEENG_H__ |
|
21 #define __MSATELLITEENG_H__ |
|
22 |
|
23 // INCLUDES |
|
24 #include <lbspositioninfo.h> |
|
25 #include <lbs.h> |
|
26 #include <locnotprefplugindomaincrkeys.h> |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class MEngObserver; |
|
30 class TSatelliteData; |
|
31 // CLASS DECLARATION |
|
32 |
|
33 /** |
|
34 * Interface class to implement all the functionality required |
|
35 * by the satellite engine |
|
36 */ |
|
37 class MSatelliteEng |
|
38 { |
|
39 public: // Constructors and destructor |
|
40 /** |
|
41 * Destructor. |
|
42 */ |
|
43 virtual ~MSatelliteEng(){}; |
|
44 |
|
45 public: // New functions |
|
46 /** |
|
47 * Sets satellite observer |
|
48 * |
|
49 * @param aObserver A reference to observer |
|
50 */ |
|
51 virtual void SetObserver(MEngObserver& aObserver) = 0; |
|
52 |
|
53 /** |
|
54 * Request satelite data |
|
55 * @param aSrvName |
|
56 */ |
|
57 virtual void RequestSatelliteDataL( const TDesC& aSrvName ) = 0; |
|
58 |
|
59 /** |
|
60 * Get satellite data |
|
61 * @param aIndex |
|
62 * @param aSatelliteData |
|
63 * @return error code |
|
64 */ |
|
65 virtual TInt GetSatelliteData( TUint aIndex, |
|
66 TSatelliteData& aSatelliteData ) const = 0; |
|
67 |
|
68 /** |
|
69 * Get Position Info |
|
70 * @param aPosition |
|
71 */ |
|
72 virtual void GetPosition(TPosition& aPosition) = 0; |
|
73 |
|
74 /** |
|
75 * Get Course Info |
|
76 * @param aCourse |
|
77 */ |
|
78 virtual void GetCourse(TCourse& aCourse) = 0; |
|
79 |
|
80 /** |
|
81 * Get Course Info |
|
82 * @param aCourse |
|
83 */ |
|
84 virtual TLocSystemofMeasurementValues SysOfMeasurementL() = 0; |
|
85 |
|
86 /** |
|
87 * Get number of satellites |
|
88 * @return number of satellites |
|
89 */ |
|
90 virtual TInt NumberOfSatellites() = 0; |
|
91 |
|
92 /** |
|
93 * Get number of satellites used |
|
94 * @return number of satellites used |
|
95 */ |
|
96 virtual TInt NumberOfSatellitesUsed() = 0; |
|
97 |
|
98 /** |
|
99 * Stop requesting |
|
100 */ |
|
101 virtual void StopRequesting() = 0; |
|
102 |
|
103 /** |
|
104 * Start requesting |
|
105 */ |
|
106 virtual void StartRequestingL() = 0; |
|
107 |
|
108 /** |
|
109 * Clears the satellite data |
|
110 * |
|
111 */ |
|
112 virtual void ClearSatelliteData() = 0; |
|
113 |
|
114 /** |
|
115 * Check if any satelllite data is available |
|
116 * |
|
117 */ |
|
118 virtual TBool IsSatelliteDataAvailable() = 0; |
|
119 |
|
120 /** |
|
121 * Function to obtain the Azimuth and elevation of sun |
|
122 */ |
|
123 virtual void GetSunAzimuthElevation(TReal& aAzimuth, TReal& aElevation ) = 0; |
|
124 |
|
125 /** |
|
126 * Function to obtain the Azimuth and elevation of moon |
|
127 */ |
|
128 virtual void GetMoonAzimuthElevation(TReal& aAzimuth, TReal& aElevation ) = 0; |
|
129 }; |
|
130 |
|
131 #endif // __MSATELLITEENG_H__ |
|
132 |
|
133 // End of File |
|