epoc-cellpos.hpp

Go to the documentation of this file.

// This is like the "gps" sensor, but only scans after GSM cell ID
// changes, and even so does not scan for too often.

#ifndef __epoc_cellpos_hpp__
#define __epoc_cellpos_hpp__

#include "application_config.h"

#if __CELLPOS_ENABLED__

#include "epoc-gps-observer.hpp"

#include "ac_app_context.h"
#include "bb_blackboard.h"
#include "epoc-ao-gerror.hpp"
#include "ld_log_db.h"
#include "ut_retry_epoc.hpp"
#include "utils_cl2.h"

#include <e32std.h>
#include <lbs.h> // link against lbs.lib
#include <lbssatellite.h>

#include <glib.h>

class CPositioner_gps;
class CPosModuleStatAo;

NONSHARABLE_CLASS(CSensor_cellpos) :
  public CBase,
  public MObserverPosMod,
  public MObserver_gps,
  public MRetryAoObserver,
  public bb::MObserver
{
 public:
  static CSensor_cellpos* NewL(ac_AppContext* aAppContext);
  virtual ~CSensor_cellpos();

 private:
  CSensor_cellpos(ac_AppContext* aAppContext);
  void ConstructL();

 private: // MObserverPosMod
  virtual void PosModChangeL();
  virtual void PosModErrorL(TInt errCode);
  virtual void PosModLeave(TInt errCode);
  virtual TBool PosModIsCurrent(TPositionModuleId id) const;

 private: // MObserver_gps
  virtual gboolean PositionerEventL(GError** error);

 private: // MRetryAoObserver
  virtual void RetryTimerExpired(CRetryAo* src, TInt errCode);

 private: // bb::MObserver
  virtual void BbChangedL(bb::RHandle* self, enum bb_DataType dt,
        gpointer data, int len);

 private:
  ac_AppContext* iAppContext; // not owned
  LogDb* iLogDb; // not owned

  CPosModuleStatAo* iModuleAo; // owned

  // Used for positioning when a suitable positioning module is
  // available. When nothing suitable is available, this is NULL.
  CPositioner_gps* iSatPositioner; // owned

  CRetryAo* iRetryAo; // owned

  bb::RHandle iCellChangeHandle;
  bb::RHandle iNetposChangeHandle;

  TTime iLastScanTime;

  enum TState {
    EInactive = 0, // not started
    EActive // asynchronous queries outstanding internally
  };
  TState iState;

  TPositionModuleId iModuleId; // current one, or KPositionNullModuleId

  TBool iAllowAssisted;

  TInt iMinScanRequestIntervalSecs; // config param
  TInt iSatelliteQueryTimeoutSecs; // config param
  TInt iDataMaxAgeSecs; // config param

 private:
  void ReadConfig();
  void CreateSpecifiedPositionerL(TPositionModuleId bestId);

 public:
  void StartL();
  void Stop();
  TBool IsActive() const { return iState != EInactive; }
  void Reconfigure(const gchar* name, const gchar* value);
};

#endif // __CELLPOS_ENABLED__

// --------------------------------------------------
// sensor array integration
// --------------------------------------------------

#if defined(SA_ARRAY_INTEGRATION)
#if __CELLPOS_ENABLED__
#define DECLARE_SENSOR_cellpos CSensor_cellpos* iSensor_cellpos
#define SENSOR_CELLPOS_DESTROY DELETE_Z(self->iSensor_cellpos)
#define SENSOR_CELLPOS_CREATE sa_typical_symbian_sensor_create(self->iSensor_cellpos = CSensor_cellpos::NewL(self->ac), "cellpos sensor initialization")
#define SENSOR_CELLPOS_START sa_trap_symbian_sensor_start(self->iSensor_cellpos, "failed to start cellpos scanning")
#define SENSOR_CELLPOS_STOP { self->iSensor_cellpos->Stop(); }
#define SENSOR_CELLPOS_IS_RUNNING (self->iSensor_cellpos->IsActive())
#define SENSOR_CELLPOS_RECONFIGURE(key,value) sa_typical_symbian_sensor_reconfigure(cellpos)
#else
#define DECLARE_SENSOR_cellpos
#endif
#endif /* SA_ARRAY_INTEGRATION */

#endif /* __epoc_cellpos_hpp__ */

/**

epoc-cellpos.hpp

Copyright 2009-2011 Helsinki Institute for Information Technology
(HIIT) and the authors. All rights reserved.

Authors: Tero Hasu <tero.hasu@hut.fi>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

 **/