locationmgmt/locmonitor/ConversionApi/ConversionCommon/inc/lbslocationinfoconvertercommon.h
branchGeoConversion
changeset 16 90477588756a
equal deleted inserted replaced
15:2cd881e4a6fb 16:90477588756a
       
     1 /*
       
     2 * Copyright (c) 2009 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: Common enumerations used by client applications and plugins 
       
    15 * for conversion of location information.
       
    16 *
       
    17 */
       
    18 
       
    19 /**
       
    20 @file
       
    21 @publishedPartner
       
    22 @prototype
       
    23 */
       
    24 
       
    25 #ifndef LBS_LOCATION_INFO_CONVERTER_COMMON_H
       
    26 #define LBS_LOCATION_INFO_CONVERTER_COMMON_H
       
    27 
       
    28 #include <e32std.h>
       
    29 
       
    30 /**
       
    31  * Conversion preferences
       
    32  */ 
       
    33 typedef TUint32 TLbsConversionPrefs;
       
    34 
       
    35 
       
    36 /**
       
    37  * Enumeration to define the preferences a client can specify while requesting
       
    38  * location information. The conversion preferences enumeration shall not be 
       
    39  * used as a bitmask. 
       
    40  * The preferences are used by conversion module in order to decide if/how
       
    41  * a connection to an external server should be established.
       
    42  */
       
    43 enum _TLbsConversionPrefs
       
    44     {
       
    45     	
       
    46     /**
       
    47      * Indicates that no preferences are specified.
       
    48      */
       
    49     ELbsConversionNotDefined = 0x0000,
       
    50     	
       
    51     /**
       
    52      * Use only local cache to retrieve information.
       
    53      */
       
    54     ELbsConversionCacheOnly  = 0x0001,
       
    55   
       
    56     /**
       
    57      * Disable prompt while making a connection to an external service for
       
    58      * conversion.
       
    59 	 * Ignored if a conversion module does not require external connection.
       
    60      */
       
    61     ELbsConversionSilent     = 0x0002,
       
    62   
       
    63     /**
       
    64      * Allow prompt while making a connection to an external service for 
       
    65      * conversion.
       
    66 	 * Ignored if a conversion module does not require external connection.
       
    67      */
       
    68     ELbsConversionPrompt     = 0x0004
       
    69   
       
    70     };  
       
    71 
       
    72 
       
    73 /**
       
    74  * Output Location Information
       
    75  */ 
       
    76 typedef TUint32 TLbsConversionOutputInfoMask;
       
    77 
       
    78 
       
    79 /**
       
    80  * Enumeration to define the type(s) of location information being communicated
       
    81  */
       
    82 enum _TLbsConversionOutputInfoMask
       
    83     { 
       
    84     
       
    85     /**
       
    86      * Used to initialise data only. Should not be used when requesting conversions.
       
    87      */
       
    88     ELbsConversionOutputNotDefined = 0x0000,
       
    89 
       
    90     /**
       
    91      * Indicates that the input data should be converted to a geographical coordinate
       
    92 	 * @see CLbsPositionInfo
       
    93      */
       
    94     ELbsConversionOutputPosition = 0x0001,
       
    95     
       
    96     /**
       
    97      * Indicates that the input data should be converted to a GSM Cell information 
       
    98 	 * @see CLbsGsmCellInfo
       
    99      */
       
   100     ELbsConversionOutputGsm = 0x0002,
       
   101     
       
   102     /**
       
   103      * Indicates that the input data should be converted to a WCDMA Cell information 
       
   104 	 * @see CLbsWcdmaCellInfo
       
   105      */
       
   106     ELbsConversionOutputWcdma = 0x0004,
       
   107     
       
   108     /**
       
   109      * Indicates that the input data should be converted to a WLAN information 
       
   110 	 * @see CLbsWlanInfo
       
   111      */
       
   112     ELbsConversionOutputWlan = 0x0008
       
   113     };
       
   114 
       
   115 #endif // LBS_LOCATION_INFO_CONVERTER_COMMON_H