epoc32/include/lbsclasstypes.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 #ifndef __LBSCLASSTYPES_H__
    18 #define __LBSCLASSTYPES_H__
    19 
    20 /**
    21 Position quality class
    22 
    23 @publishedAll
    24 @released
    25 */
    26 
    27 enum TPositionClassFamily
    28 	{
    29 	/** EPositionInfoFamily
    30 	All classes supported by the positioning module that are derived from
    31 	TPositionInfoBase. For example, TPositionInfo and TPositionCourseInfo.
    32 
    33 	When this values is passed to the ClassesSupported() method, it will
    34 	return a bit mask of values corresponding to the enumeration
    35 	TPositionInfoClassType.
    36  	*/
    37 	EPositionInfoFamily,
    38 
    39 	/** EPositionModuleInfoFamily
    40 	All classes supported by the positioning module that are derived from
    41 	TPositionModuleInfoBase. For example, TPositionModuleInfo.
    42 
    43 	When this values is passed to the ClassesSupported() method, it will return
    44 	a bit mask of values 	corresponding to the enumeration
    45 	TPositionModuleInfoClassType
    46 	 */
    47 	EPositionModuleInfoFamily,
    48 
    49 	/** EPositionModuleStatusFamily
    50 	All classes supported by the positioning module that are derived from
    51 	TPositionModuleStatusBase. For example, TPositionModuleStatus.
    52 
    53 	When this values is passed to the ClassesSupported() method, it will return
    54 	a bit mask of values corresponding to the enumeration TPositionModuleStatusClassType
    55 	 */
    56 	EPositionModuleStatusFamily,
    57 
    58 	/** EPositionModuleStatusEventFamily
    59 	All classes supported by the positioning module that are derived from
    60 	TPositionModuleStatusEventBase. For example, TPositionModuleStatusEvent.
    61 
    62 	When this values is passed to the ClassesSupported() method, it will return
    63 	a bit mask of values corresponding to the enumeration PositionModuleStatusEventClassType
    64 	 */
    65 	EPositionModuleStatusEventFamily,
    66 
    67 	/** EPositionModuleQualityFamily
    68 	All classes supported by the positioning module that are derived from
    69 	TPositionQualityBase. For example, TPositionQuality.
    70 
    71 	When this values is passed to the ClassesSupported() method, it will return
    72 	a bit mask of values corresponding to the enumeration TPositionQualityClassType.
    73 	 */
    74 	EPositionModuleQualityFamily,
    75 
    76 	/** EPositionPositionCriteriaFamily
    77 	All classes supported by the positioning module that are derived from
    78 	TPositionCriteriaBase. For example, TPositionCriteria.
    79 
    80 	When this values is passed to the ClassesSupported() method, it will return
    81 	a bit mask of values corresponding to the enumeration TPositionCriteriaClassType
    82 	 */
    83 	EPositionPositionCriteriaFamily,
    84 
    85 	/** EPositionUpdateOptionsFamily
    86 	All classes supported by the positioning module that are derived from
    87 	TPositionUpdateOptionsBase. For example, TPositionUpdateOptions.
    88 
    89 	When this values is passed to the ClassesSupported() method, it will return
    90 	a bit mask of values from the enumeration TPositionUpdateOptionsClassType.
    91 	 */
    92 	EPositionUpdateOptionsFamily,
    93 
    94 	/** EPositionLastFamily */
    95 	EPositionLastFamily = 20
    96 	};
    97 
    98 /**
    99 Position quality class types
   100 
   101 @publishedAll
   102 @released
   103  */
   104 enum _TPositionQualityClassType
   105 	{
   106 	/** EPositionQualityUnknownClass */
   107 	EPositionQualityUnknownClass		= 0,
   108 	/** EPositionQualityClass */
   109 	EPositionQualityClass				= 0x01,
   110 	/** EPositionQualityFirstCustomClass */
   111 	EPositionQualityFirstCustomClass	= 0x01000000
   112 	};
   113 
   114 /**
   115 Position module information class types
   116 
   117 @publishedAll
   118 @released
   119  */
   120 enum _TPositionModuleInfoClassType
   121 	{
   122 	/** EPositionModuleInfoUnknownClass */
   123 	EPositionModuleInfoUnknownClass		= 0,
   124 	/** EPositionModuleInfoClass */
   125 	EPositionModuleInfoClass			= 0x01,
   126 	/** EPositionModuleInfoFirstCustomClass */
   127 	EPositionModuleInfoFirstCustomClass	= 0x01000000
   128 	};
   129 
   130 /**
   131 Position module status class types
   132 
   133 @publishedAll
   134 @released
   135  */
   136 enum _TPositionModuleStatusClassType
   137 	{
   138 	/** EPositionModuleStatusUnknownClass */
   139 	EPositionModuleStatusUnknownClass		= 0,
   140 	/** EPositionModuleStatusClass */
   141 	EPositionModuleStatusClass				= 0x01,
   142 	/** EPositionModuleStatusFirstCustomClass */
   143 	EPositionModuleStatusFirstCustomClass	= 0x01000000
   144 	};
   145 
   146 /**
   147 Position module status event class types
   148 
   149 @publishedAll
   150 @released
   151  */
   152 enum _TPositionModuleStatusEventClassType
   153 	{
   154 	/** EPositionModuleStatusEventUnknownClass */
   155 	EPositionModuleStatusEventUnknownClass		= 0,
   156 	/** EPositionModuleStatusEventClass */
   157 	EPositionModuleStatusEventClass				= 0x01,
   158 	/** EPositionModuleStatusEventFirstCustomClass */
   159 	EPositionModuleStatusEventFirstCustomClass	= 0x01000000
   160 	};
   161 
   162 /**
   163 Position update options class types
   164 
   165 @publishedAll
   166 @released
   167  */
   168 enum _TPositionUpdateOptionsClassType
   169 	{
   170 	/** EPositionUpdateOptionsUnknownClass */
   171 	EPositionUpdateOptionsUnknownClass		= 0,
   172 	/** EPositionUpdateOptionsClass */
   173 	EPositionUpdateOptionsClass				= 0x01,
   174 	/** EPositionUpdateOptionsFirstCustomClass */
   175 	EPositionUpdateOptionsFirstCustomClass	= 0x01000000
   176 	};
   177 
   178 /**
   179 TPositionInfoBase derived classes class types
   180 
   181 @publishedAll
   182 @released
   183  */
   184 enum _TPositionInfoClassType
   185 	{
   186 	/** EPositionInfoUnknownClass */
   187 	EPositionInfoUnknownClass		= 0,
   188 	/** EPositionInfoClass */
   189 	EPositionInfoClass				= 0x01,
   190 	/** EPositionGenericInfoClass */
   191 	EPositionGenericInfoClass		= 0x02,
   192 	/** EPositionCourseInfoClass */
   193 	EPositionCourseInfoClass		= 0x04,
   194 	/** EPositionSatelliteInfoClass */
   195 	EPositionSatelliteInfoClass		= 0x08,
   196 	/** EPositionGpsMeasurementInfoClass */
   197 	EPositionGpsMeasurementInfoClass = 0x10,
   198 	/** EPositionInfoFirstCustomClass */
   199 	EPositionInfoFirstCustomClass	= 0x01000000
   200 	};
   201 
   202 /**
   203 TPositionCriteriaBase derived classes class types
   204 
   205 @publishedAll
   206 @released
   207  */
   208 enum _TPositionCriteriaClassType
   209 	{
   210 	/** EPositionCriteriaUnknownClass */	
   211 	EPositionCriteriaUnknownClass		= 0,
   212 	/** EPositionCriteriaClass */
   213 	EPositionCriteriaClass				= 0x01,
   214 	/** EPositionCriteriaFirstCustomClass */
   215 	EPositionCriteriaFirstCustomClass	= 0x01000000
   216 	};
   217 
   218 /**
   219 Define type for TPositionInfoClassType as TUint32
   220 @publishedAll
   221 @released
   222  */
   223 typedef TUint32 TPositionInfoClassType;
   224 
   225 
   226 #endif //__LBSCLASSTYPES_H__