summaryrefslogtreecommitdiffstats
path: root/src/location/symbian_lbstracker_p.h
blob: 32183adb2b95317454618cab0b6d74bf03a9e7ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef SYMBIAN_LBSTRACKER_H
#define SYMBIAN_LBSTRACKER_H


#include <QObject>
#include "qmobilityglobal.h"
#include "qgeopositioninfo.h"

#include "symbian_lbsfacade_p.h"
#include <QGeoPositionInfo>
#include <QGeoPositionInfoSource>

#include "qgeopositioninfo.h"
#include "qgeopositioninfosource.h"

#include <lbssatellite.h>


QT_BEGIN_HEADER
QTM_BEGIN_NAMESPACE

class CLbsPositionTrackerBase;
class CTrackingPsy;

class MLbsTrackingCallback
{
public:
    virtual void TrackingLocation(QGeoPositionInfo *aPosition, CLbsPositionTrackerBase *aTracker) = 0;
    virtual void TrackingRequestTimedOut(CLbsPositionTrackerBase *aBase) = 0;
};

//Base class for all tracking requestors
class CLbsPositionTrackerBase : public CBase
{
public:
    QString iTrackerName;//Only for debugging purposes
    enum TrackingType {
        AllPsys = 1,
        GPSOnly,
        NWOnly
    };
    virtual ~CLbsPositionTrackerBase();
    virtual void StartUpdates() = 0;
    virtual void StopUpdates() = 0;
    virtual void SetUpdateInterval(TMilliSeconds mSec) = 0;
    void SetObserver(MLbsTrackingCallback *aObserver);

    TMilliSeconds GetUpdateInterval() const;
    TMilliSeconds GetMinimumUpdateInterval() const;
    CLbsPositionTrackerBase::TrackingType GetTrackingType() const;
    QGeoPositionInfo* GetLastPosition() const;

protected:
    CLbsPositionTrackerBase(TrackingType aType, CPsyContainer *aContainer, MLbsTrackingCallback *aObserver);

    TrackingType iTrackType;
    MLbsTrackingCallback *iObserver;
    CPsyContainer *iContainer;
    QGeoPositionInfo  *iLatestQPosInfo;
    QGeoPositionInfo  *iLastQPosInfo;
    TTimeIntervalMicroSeconds  iUpdateInterval;
    TTimeIntervalMicroSeconds iMinUpdateInterval;
};

class LbsTrackTimerStateBase;
class LbsTrackTimerIdleState;
class LbsTrackTimerFFState;
class LbsTrackTimerTimedoutState;
class LbsTrackTimerRunningState;

class CLbsTrackTimerBase : public CLbsPositionTrackerBase, public CTimer
        , public MPsyRequestCallback, public MPsyCountChangeCallback
{
public:
    //CLbsPositionTrackerBase
    void StartUpdates();
    void StopUpdates();
    void SetUpdateInterval(TMilliSeconds mSec);

protected:
    CLbsTrackTimerBase(TrackingType aType, CPsyContainer *aContainer,
                       MLbsTrackingCallback *aObserver, TTimeIntervalMicroSeconds32 aTTFFTimeOut);
    void ConstructL();
    ~CLbsTrackTimerBase();

    //MPsyRequestCallback
    void LocationUpdate(TPositionInfoBase &aPosition, CSelfManagingPsy *aPsy);
    void RequestTimedOut(CSelfManagingPsy *aPsy);
    //CTimer
    void RunL();
    void DoCancel();

    void CancelPsyRequests();

    //MPsyCountChangeCallback
    void PsyUninstalled(TPositionModuleId &aModId);
    void PsyInstalled(TPositionModuleInfo* aModInfo);

    void InitializePSYs(RArray<TPositionModuleInfo*>  aModInfoArray, const TInt64 aDefaultMinInterval);

    RArray<CTrackingPsy*> iTrackingPsys;
    TTimeIntervalMicroSeconds32 iTTFFTimeOut;
    LbsTrackTimerStateBase *iCurrentState;
    LbsTrackTimerStateBase *iIdleState;
    LbsTrackTimerStateBase *iFirstFixState;
    LbsTrackTimerStateBase *iTimedoutState;
    LbsTrackTimerStateBase *iRunningState;
private:
    void SetNextState(LbsTrackTimerStateBase *aNextState);

    friend class LbsTrackTimerStateBase;
    friend class LbsTrackTimerIdleState;
    friend class LbsTrackTimerFFState;
    friend class LbsTrackTimerTimedoutState;
    friend class LbsTrackTimerRunningState;
};

//Satellite based tracking requestor
class CLbsSatellitePositionTracker : public CLbsTrackTimerBase
{
public:
    static CLbsSatellitePositionTracker* NewL(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver);
    ~CLbsSatellitePositionTracker();
private:
    CLbsSatellitePositionTracker(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver);
    void ConstructL();
};

//Non Satellite based tracking requestor
class CLbsNonSatellitePositionTracker : public CLbsTrackTimerBase
{
public:
    static CLbsNonSatellitePositionTracker* NewL(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver);

    ~CLbsNonSatellitePositionTracker();
private:
    CLbsNonSatellitePositionTracker(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver);
    void ConstructL();
};

class CLbsAllPosProxyState;

//Proxy which internally uses the satellite tracker and NW tracker
class CLbsAllPosProxy : public CLbsPositionTrackerBase, public MLbsTrackingCallback
{
public:

    static CLbsAllPosProxy* NewL(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver,
                                 CLbsSatellitePositionTracker *aSatelliteTracker = NULL, CLbsNonSatellitePositionTracker *aNWTracker = NULL);

    CLbsSatellitePositionTracker* ReleaseSatelliteTracker();
    CLbsNonSatellitePositionTracker* ReleaseNWTracker();

    ~CLbsAllPosProxy();

private:

    CLbsAllPosProxy(CPsyContainer *aContainer, MLbsTrackingCallback *aObserver,
                    CLbsSatellitePositionTracker *aSatelliteTracker = NULL, CLbsNonSatellitePositionTracker *aNWTracker = NULL);

    void ConstructL(CLbsSatellitePositionTracker *aSatelliteTracker , CLbsNonSatellitePositionTracker *aNWTracker);

    //Should be propagated to the other Satellite and NW trackers
    void SetUpdateInterval(TMilliSeconds mSec);
    void StartUpdates();
    void StopUpdates();

    //Used for listening to updates from satellite tracker and NW Tracker
    void TrackingLocation(QGeoPositionInfo *aPosition, CLbsPositionTrackerBase *aTracker);
    void TrackingRequestTimedOut(CLbsPositionTrackerBase *aBase);

    void SetNextState(CLbsAllPosProxyState *nextState);

    void NotifyFixToObserver(QGeoPositionInfo *aPosition);
    void NotifyTimeOutToObserver();

    CLbsSatellitePositionTracker *iSatelliteTracker;
    CLbsNonSatellitePositionTracker *iNWTracker;

    CLbsAllPosProxyState *iCurrentState;
    //states
    CLbsAllPosProxyState *iIdle;
    CLbsAllPosProxyState *iInitialHybrid;
    CLbsAllPosProxyState *iSatelliteOnly;
    CLbsAllPosProxyState *iRunningHybrid;

    friend class CLbsAllPosIdle;
    friend class CLbsAllPosInitialHybrid;
    friend class CLbsAllPosSatelliteOnly;
    friend class CLbsAllPosRunningHybrid;
};


class CTrackingPsy : public CSelfManagingPsy
{
public:
    static CTrackingPsy* NewL(TPositionModuleInfo* aPsy, CPsyContainer *aContainer,
                              MPsyRequestCallback* aRequestCallback);
    virtual ~CTrackingPsy();
    void IssueRequest(TTimeIntervalMicroSeconds updateInterval);

protected:
    CTrackingPsy(TPositionModuleInfo* aPsy, CPsyContainer *aContainer, MPsyRequestCallback* aRequestCallback, TPositionInfoBase &aPos);
    void ConstructL();
    void RunL();
};



QTM_END_NAMESPACE
QT_END_HEADER

#endif