locationtriggering/ltserver/ltserverlogic/inc/lbtsettingsmanager.h
author hgs
Wed, 03 Nov 2010 23:28:39 +0530
changeset 56 4e949f03ecc5
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Responsible for settings and retreiving all location 
hgs
parents:
diff changeset
    15
*				 triggering settings
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef LBTSETTINGSMANAGER_H
hgs
parents:
diff changeset
    21
#define LBTSETTINGSMANAGER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// INCLUDE FILES
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
#include <lbscommon.h>
hgs
parents:
diff changeset
    26
#include <lbtcommon.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    29
class CRepository;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
/**
hgs
parents:
diff changeset
    32
 * Class declaration for location triggering settings manager
hgs
parents:
diff changeset
    33
 * All reads and write to the Central Repository keys of
hgs
parents:
diff changeset
    34
 * location triggering settings has to be done through this 
hgs
parents:
diff changeset
    35
 * interface. This is a singelton class
hgs
parents:
diff changeset
    36
 * 
hgs
parents:
diff changeset
    37
 * @since S60 v4.0
hgs
parents:
diff changeset
    38
 */
hgs
parents:
diff changeset
    39
class CLbtSettingsManager : public CBase
hgs
parents:
diff changeset
    40
	{
hgs
parents:
diff changeset
    41
	public:
hgs
parents:
diff changeset
    42
		/**
hgs
parents:
diff changeset
    43
	     * Instantiates a new object of 
hgs
parents:
diff changeset
    44
	     * CLbtSettingsManager
hgs
parents:
diff changeset
    45
	     *
hgs
parents:
diff changeset
    46
	     * @return NULL when there isn't enough memory otherwise
hgs
parents:
diff changeset
    47
	     * pointer to an object of type CLbtSettingsManager
hgs
parents:
diff changeset
    48
	     *
hgs
parents:
diff changeset
    49
	     */
hgs
parents:
diff changeset
    50
	    static CLbtSettingsManager* NewL( );
hgs
parents:
diff changeset
    51
	    
hgs
parents:
diff changeset
    52
	    /**
hgs
parents:
diff changeset
    53
	     * Destructor
hgs
parents:
diff changeset
    54
	     *
hgs
parents:
diff changeset
    55
	     */
hgs
parents:
diff changeset
    56
	    ~CLbtSettingsManager();
hgs
parents:
diff changeset
    57
	    
hgs
parents:
diff changeset
    58
	private:
hgs
parents:
diff changeset
    59
		/**
hgs
parents:
diff changeset
    60
	     * 2nd phase constuctor for instantiating member variables
hgs
parents:
diff changeset
    61
	     *
hgs
parents:
diff changeset
    62
	     */
hgs
parents:
diff changeset
    63
		void ConstructL();
hgs
parents:
diff changeset
    64
		
hgs
parents:
diff changeset
    65
	public: // New functions
hgs
parents:
diff changeset
    66
		
hgs
parents:
diff changeset
    67
		/**
hgs
parents:
diff changeset
    68
		 * Sets the optimization
hgs
parents:
diff changeset
    69
		 *
hgs
parents:
diff changeset
    70
		 * @param[in] aOptimizationLevel the optimization level which 
hgs
parents:
diff changeset
    71
		 * is the balance between accuracy and optimization level
hgs
parents:
diff changeset
    72
		 */
hgs
parents:
diff changeset
    73
		void SetOptimizationLevel(TInt aOptimizationLevel);
hgs
parents:
diff changeset
    74
		
hgs
parents:
diff changeset
    75
		/**
hgs
parents:
diff changeset
    76
		 * Get the optimization settings which is the balance
hgs
parents:
diff changeset
    77
		 * between accuracy and optimization level
hgs
parents:
diff changeset
    78
		 *
hgs
parents:
diff changeset
    79
		 * @return interger optimization level
hgs
parents:
diff changeset
    80
		 */
hgs
parents:
diff changeset
    81
		TInt GetOptimizationLevel();
hgs
parents:
diff changeset
    82
		
hgs
parents:
diff changeset
    83
		/**
hgs
parents:
diff changeset
    84
		 * Sets the module id that the trigger server has to
hgs
parents:
diff changeset
    85
		 * use to obtain location fixes
hgs
parents:
diff changeset
    86
		 *
hgs
parents:
diff changeset
    87
		 * @param[in] aModuleId position module id
hgs
parents:
diff changeset
    88
		 */
hgs
parents:
diff changeset
    89
		void SetModuleId(TPositionModuleId aModuleId);
hgs
parents:
diff changeset
    90
		
hgs
parents:
diff changeset
    91
		/**
hgs
parents:
diff changeset
    92
		 * Gets the module id which has to used to get
hgs
parents:
diff changeset
    93
		 * position fixes
hgs
parents:
diff changeset
    94
		 * 
hgs
parents:
diff changeset
    95
		 * @return the module id used
hgs
parents:
diff changeset
    96
		 */ 
hgs
parents:
diff changeset
    97
		TPositionModuleId GetModuleId();
hgs
parents:
diff changeset
    98
		
hgs
parents:
diff changeset
    99
		/**
hgs
parents:
diff changeset
   100
		 * Gets the module id of NPP PSY which has to used to get
hgs
parents:
diff changeset
   101
		 * network based position fixes
hgs
parents:
diff changeset
   102
		 * 
hgs
parents:
diff changeset
   103
		 * @return the module id of NPP PSY
hgs
parents:
diff changeset
   104
		 */ 
hgs
parents:
diff changeset
   105
		TPositionModuleId GetNppModuleId();
hgs
parents:
diff changeset
   106
		
hgs
parents:
diff changeset
   107
		/**
hgs
parents:
diff changeset
   108
		 * Sets the minumum update interal that has to be set
hgs
parents:
diff changeset
   109
		 * to get position updates
hgs
parents:
diff changeset
   110
		 *
hgs
parents:
diff changeset
   111
		 * @param[in] aUpdateInterval the minimum update interval
hgs
parents:
diff changeset
   112
		 */ 
hgs
parents:
diff changeset
   113
		void SetMinimumUpdateInterval(TInt aUpdateInterval);
hgs
parents:
diff changeset
   114
		
hgs
parents:
diff changeset
   115
		/**
hgs
parents:
diff changeset
   116
		 * Gets the minumum update interal that has to be set
hgs
parents:
diff changeset
   117
		 * to get position updates
hgs
parents:
diff changeset
   118
		 *
hgs
parents:
diff changeset
   119
		 * @return the minimum update interval
hgs
parents:
diff changeset
   120
		 */ 
hgs
parents:
diff changeset
   121
		TInt GetMinimumUpdateInterval();
hgs
parents:
diff changeset
   122
		
hgs
parents:
diff changeset
   123
		/**
hgs
parents:
diff changeset
   124
		 * Sets the minimum update interavl when
hgs
parents:
diff changeset
   125
		 * GPS fails
hgs
parents:
diff changeset
   126
		 *
hgs
parents:
diff changeset
   127
		 * @param[in] aUpdateInterval the minimum update interval 
hgs
parents:
diff changeset
   128
		 */
hgs
parents:
diff changeset
   129
		void SetMinimumUpdateIntervalOnGpsFailure(TInt aUpdateInterval);
hgs
parents:
diff changeset
   130
		
hgs
parents:
diff changeset
   131
		/**
hgs
parents:
diff changeset
   132
		 * Gets the minimum update interavl when
hgs
parents:
diff changeset
   133
		 * GPS fails
hgs
parents:
diff changeset
   134
		 *
hgs
parents:
diff changeset
   135
		 * @return the minimum update interval 
hgs
parents:
diff changeset
   136
		 */
hgs
parents:
diff changeset
   137
		TInt GetMinimumUpdateIntervalOnGpsFailure();
hgs
parents:
diff changeset
   138
		
hgs
parents:
diff changeset
   139
		/**
hgs
parents:
diff changeset
   140
		 * Sets the maximum user speed used for update interval
hgs
parents:
diff changeset
   141
		 * calculations
hgs
parents:
diff changeset
   142
		 * 
hgs
parents:
diff changeset
   143
		 * @param[in] aSpeed maximum user speed to be set
hgs
parents:
diff changeset
   144
		 */
hgs
parents:
diff changeset
   145
		void SetMaximumUserSpeed(TInt aSpeed);
hgs
parents:
diff changeset
   146
		
hgs
parents:
diff changeset
   147
		/**
hgs
parents:
diff changeset
   148
		 * Gets the maximum user speed used for update interval
hgs
parents:
diff changeset
   149
		 * calculations
hgs
parents:
diff changeset
   150
		 * 
hgs
parents:
diff changeset
   151
		 * @return maximum user speed to be set
hgs
parents:
diff changeset
   152
		 */
hgs
parents:
diff changeset
   153
		TInt GetMaximumUserSpeed();
hgs
parents:
diff changeset
   154
		
hgs
parents:
diff changeset
   155
		/**
hgs
parents:
diff changeset
   156
		 * Sets the triggering mechanism state
hgs
parents:
diff changeset
   157
		 *
hgs
parents:
diff changeset
   158
		 * @param[in] aState state of the triggering mechanism
hgs
parents:
diff changeset
   159
		 */
hgs
parents:
diff changeset
   160
		void SetTriggeringMechanismState(TLbtTriggeringMechanismState aState);
hgs
parents:
diff changeset
   161
		
hgs
parents:
diff changeset
   162
		/**
hgs
parents:
diff changeset
   163
		 * Gets the triggering mechanism state
hgs
parents:
diff changeset
   164
		 *
hgs
parents:
diff changeset
   165
		 * @return state of the triggering mechanism
hgs
parents:
diff changeset
   166
		 */
hgs
parents:
diff changeset
   167
		TInt GetTriggeringMechanismState();
hgs
parents:
diff changeset
   168
		
hgs
parents:
diff changeset
   169
	public: // Getter routines for trigger configurable parameters
hgs
parents:
diff changeset
   170
		
hgs
parents:
diff changeset
   171
		/**
hgs
parents:
diff changeset
   172
		 * Gets the minimum area that a trigger entry should have
hgs
parents:
diff changeset
   173
		 *
hgs
parents:
diff changeset
   174
		 * @return the triggering area
hgs
parents:
diff changeset
   175
		 */
hgs
parents:
diff changeset
   176
		TInt MinimumTriggeringArea();
hgs
parents:
diff changeset
   177
		
hgs
parents:
diff changeset
   178
		/**
hgs
parents:
diff changeset
   179
		 * Gets the tracking mode interval
hgs
parents:
diff changeset
   180
		 *
hgs
parents:
diff changeset
   181
		 * @return gets the tracking mode interval
hgs
parents:
diff changeset
   182
		 */
hgs
parents:
diff changeset
   183
		TInt TrackingModeInterval();
hgs
parents:
diff changeset
   184
		
hgs
parents:
diff changeset
   185
		/**
hgs
parents:
diff changeset
   186
		 * Gets the location request time out value
hgs
parents:
diff changeset
   187
		 *
hgs
parents:
diff changeset
   188
		 * @return location request time out
hgs
parents:
diff changeset
   189
		 */
hgs
parents:
diff changeset
   190
		TInt GetLocationRequestTimeOut();
hgs
parents:
diff changeset
   191
		
hgs
parents:
diff changeset
   192
		/**
hgs
parents:
diff changeset
   193
		 * Gets the minimum size of hysteresis area. This
hgs
parents:
diff changeset
   194
		 * is basically the radius of the hysteresis ring
hgs
parents:
diff changeset
   195
		 *
hgs
parents:
diff changeset
   196
		 * @return minimum size of hysteresis area
hgs
parents:
diff changeset
   197
		 */
hgs
parents:
diff changeset
   198
		TInt MinimumHysteresisArea();
hgs
parents:
diff changeset
   199
		
hgs
parents:
diff changeset
   200
		/**
hgs
parents:
diff changeset
   201
		 * Get the number of days that start up triggers can
hgs
parents:
diff changeset
   202
		 * be preserved in the system when the owner application
hgs
parents:
diff changeset
   203
		 * is not present in the system.
hgs
parents:
diff changeset
   204
		 *
hgs
parents:
diff changeset
   205
		 * @return number of days
hgs
parents:
diff changeset
   206
		 */
hgs
parents:
diff changeset
   207
		TInt NumberOfDaysForCleanup();
hgs
parents:
diff changeset
   208
		
hgs
parents:
diff changeset
   209
		/**
hgs
parents:
diff changeset
   210
		 * Gets the count of maximum enabled and valid triggers that
hgs
parents:
diff changeset
   211
		 * can be present in the system at any point in time.
hgs
parents:
diff changeset
   212
		 *
hgs
parents:
diff changeset
   213
		 * @return count of enabled and valid triggers
hgs
parents:
diff changeset
   214
		 */
hgs
parents:
diff changeset
   215
		TInt EnabledValidTriggerCount();
hgs
parents:
diff changeset
   216
hgs
parents:
diff changeset
   217
	private: // Member variables
hgs
parents:
diff changeset
   218
	
hgs
parents:
diff changeset
   219
		// Optimization level
hgs
parents:
diff changeset
   220
		TInt iOptimizationLevel;
hgs
parents:
diff changeset
   221
		
hgs
parents:
diff changeset
   222
		// Module id to be used to make update intervals
hgs
parents:
diff changeset
   223
		TInt iModuleId;
hgs
parents:
diff changeset
   224
		
hgs
parents:
diff changeset
   225
		// Update interval for position requests
hgs
parents:
diff changeset
   226
		TInt iMinUpdateInterval;
hgs
parents:
diff changeset
   227
		
hgs
parents:
diff changeset
   228
		// Minimum update interval on gps failure
hgs
parents:
diff changeset
   229
		TInt iMinUpdateIntervalOnGpsFailure;
hgs
parents:
diff changeset
   230
		
hgs
parents:
diff changeset
   231
		// Maximum user speed setting
hgs
parents:
diff changeset
   232
		TInt iMaxUserSpeed;
hgs
parents:
diff changeset
   233
		
hgs
parents:
diff changeset
   234
		// Triggering mechanism. i.e. on or off
hgs
parents:
diff changeset
   235
		TInt iTriggeringMechanismState;
hgs
parents:
diff changeset
   236
		
hgs
parents:
diff changeset
   237
		// Minimum trigger area
hgs
parents:
diff changeset
   238
		TInt iMinimumTriggerArea;
hgs
parents:
diff changeset
   239
		
hgs
parents:
diff changeset
   240
		// Track mode interval
hgs
parents:
diff changeset
   241
		TInt iTrackModeInterval;
hgs
parents:
diff changeset
   242
		
hgs
parents:
diff changeset
   243
		// Location request time out
hgs
parents:
diff changeset
   244
		TInt iLocRequestTimeOut;
hgs
parents:
diff changeset
   245
		
hgs
parents:
diff changeset
   246
		// Minimum hysteresis area
hgs
parents:
diff changeset
   247
		TInt iMinHysteresisArea;
hgs
parents:
diff changeset
   248
		
hgs
parents:
diff changeset
   249
		// Number of days for cleanup of triggers in system
hgs
parents:
diff changeset
   250
		TInt iDaysForCleanup;
hgs
parents:
diff changeset
   251
		
hgs
parents:
diff changeset
   252
		// Count of enabled and valid triggers that can be present in tht system
hgs
parents:
diff changeset
   253
		TInt iEnabledValidTriggerCount;
hgs
parents:
diff changeset
   254
		
hgs
parents:
diff changeset
   255
		// Module ID of NPP (Network positioning) PSY
hgs
parents:
diff changeset
   256
		TInt iNppModuleId;
hgs
parents:
diff changeset
   257
hgs
parents:
diff changeset
   258
		// Pointer an cenrep object
hgs
parents:
diff changeset
   259
		CRepository* iRepository;
hgs
parents:
diff changeset
   260
	};
hgs
parents:
diff changeset
   261
hgs
parents:
diff changeset
   262
#endif // LBTSETTINGSMANAGER_H