locationmgmt/locmonitor/test/ExampleLocationConverter/inc/ExampleLocationConverter.h
author hgs
Tue, 13 Jul 2010 12:25:28 +0100
changeset 48 81c9bee26a45
permissions -rw-r--r--
201025_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     1
/*
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     3
* All rights reserved.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     8
*
81c9bee26a45 201025_02
hgs
parents:
diff changeset
     9
* Initial Contributors:
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    11
*
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    12
* Contributors:
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    13
*
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    14
* Description:  Definition of Movement Detection API
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    15
*
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    16
*/
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    17
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    18
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    19
#ifndef C_EXAMPLELOCATIONCONVERTER_H
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    20
#define C_EXAMPLELOCATIONCONVERTER_H
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    21
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    22
#include <e32base.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    23
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    24
#include <commdb.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    25
#include <lbs/lbslocinfoconverterpluginbase.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    26
#include <lbs/lbslocinfoconverterpluginclasstypes.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    27
#include <lbs/lbslocinfoconverterplugincommon.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    28
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    29
#include <lbs/lbslocationinfoconvertercommon.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    30
#include <lbs/lbslocationclasstypes.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    31
#include <lbs/lbslocationcommon.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    32
#include <lbs/lbslocationposinfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    33
#include <lbs/lbslocationgsminfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    34
#include <lbs/lbslocationgsmneighbourinfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    35
#include <lbs/lbslocationinfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    36
#include <lbs/lbslocationwcdmainfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    37
#include <lbs/lbslocationwcdmaneighbourinfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    38
#include <lbs/lbslocationwlaninfo.h>
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    39
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    40
/**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    41
 *  CExampleLocationConverter is an ECom plugin that implements CLbsLocInfoConversionPluginBase.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    42
 *
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    43
 *  This class is responsible for monitering movement of mobile based on
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    44
 *  GSM information available to mobile at any instant.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    45
 *
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    46
 *  @lib movementdetector.lib
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    47
 *  @since  S60 v4.0
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    48
 */
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    49
class CExampleLocationConverter : public CLbsLocInfoConverterPluginBase
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    50
										
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    51
    {
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    52
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    53
public:
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    54
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    55
    /**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    56
     * Loads a location info conveter and initalises it.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    57
     * 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    58
     * @param[in] aObserver An observer for location conversion event.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    59
     * @param[in] aPluginArgs Agruements sent to conversion plugin.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    60
     * return Pointer to the new loation info converter.If module id is not specified
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    61
     * default plug in will be loaded.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    62
     */
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    63
    static CExampleLocationConverter* NewL( TLbsLocInfoConverterPluginParams& aPluginParams );
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    64
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    65
    /**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    66
     * Unloads this movement detector.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    67
     *
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    68
     * @since S60 TACO
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    69
     */
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    70
     virtual ~CExampleLocationConverter();
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    71
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    72
	// From CLbsLocInfoConversionPluginBase
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    73
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    74
     /**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    75
          * Converts the area informations of a group of geographical locations
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    76
          * to its corresponding position information.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    77
          * 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    78
          * @param[in] aLocationInfoArray Array of location informations corresponding 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    79
          * to geographical locations are passed and on successful completion of this 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    80
          * method,position information corresponding to the loation informations are  
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    81
          * updated in each area info object.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    82
          * @param[in] aConversionPrefs Conversion preferences suggested by client.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    83
          * 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    84
          * @leave KErrArgument If the location info array is empty.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    85
          */
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    86
     virtual void ConvertLocationInfoL( 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    87
             RLbsLocationInfoArray& aLocationInfoArray,
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    88
             const TLbsConversionPrefs aConversionPrefs, 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    89
             const TLbsConversionOutputInfoMask aRequestedInfo );
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    90
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    91
     /**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    92
      * Cancels get location info operation.
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    93
      */     
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    94
     virtual void CancelConvertLocationInfo();
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    95
     
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    96
     virtual void ValidateClient( const TSecureId& aSecureId, 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    97
                                  const TVendorId& aVendorId,
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    98
                                  const TLbsConversionOutputInfoMask aRequestedInfo );
81c9bee26a45 201025_02
hgs
parents:
diff changeset
    99
                                  
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   100
     virtual void CancelValidateClient();        
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   101
     
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   102
     virtual void ConversionPluginPreferences(
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   103
                 TLbsConversionPluginInfo& aPluginInfo );
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   104
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   105
private:
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   106
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   107
	
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   108
	 void ConstructL(TLbsLocInfoConverterPluginParams& aPluginParams);
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   109
	
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   110
	/**
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   111
	 * Default C++ Constructor
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   112
	 */
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   113
	 CExampleLocationConverter(TLbsLocInfoConverterPluginParams& aParams);
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   114
	 
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   115
private: // data
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   116
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   117
    MLbsLocInfoConverterPluginObserver &iObserver;
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   118
    TBool iRetainLocalityInCache;
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   119
    };
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   120
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   121
81c9bee26a45 201025_02
hgs
parents:
diff changeset
   122
#endif // C_LBTCELLIDMVMTDET_H