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