C:/Data/Dev/Synergy/MCL/lbs/lbs/locationmgmt/locmonitor/lbslocmonitorapis/ConversionDataTypes/inc/lbslocationinfo.h File Reference

#include <e32std.h>
#include <lbs/lbslocationcommon.h>
#include <lbs/lbslocationwcdmainfo.h>
#include <lbs/lbslocationgsminfo.h>
#include <lbs/lbslocationwlaninfo.h>
#include <lbs/lbslocationposinfo.h>

Go to the source code of this file.

Typedefs

typedef RPointerArray
< CLbsAreaInfoBase > 
RLbsAreaInfoBaseArray
typedef RPointerArray
< CLbsLocationInfo > 
RLbsLocationInfoArray

Functions

 NONSHARABLE_CLASS (CLbsLocationInfo)

Detailed Description


Typedef Documentation

typedef RPointerArray<CLbsAreaInfoBase> RLbsAreaInfoBaseArray

Type definitions Structure used to carry location information to be converted


Function Documentation

NONSHARABLE_CLASS ( CLbsLocationInfo   ) 

This class contains information related to a collection of geographical area information. Client applications create an instance of this class to represent a geographical area for which a conversion is required. The corresponding coordinate values determined by the conversion plugins would be updated in the same instance of CLbsLocationInfo. Client applications may retrieve the position estimate(s) using GetPositionInfo method.

Bit mask used to retrieve position information.

Bit mask used to retrieve GSM cell information.

Bit mask used to retrieve WCDMA cell information.

Bit mask used to retrieve WLAN AP information.

Bit mask used to retrieve all area information.

Allocates and constructs a new location info object.

Returns:
Pointer to the new area info object. Standard symbian error codes, such as KErrNoMemory

Allocates and constructs a new location info object. This method will push the resultant object onto the cleanup stack.

Returns:
Pointer to the new area info object. Standard symbian error codes, such as KErrNoMemory

Destructor

Appends the specified area info entry to the data structure. This method takes a pointer to CLbsAreaInfoBase type instances.

Parameters:
[in] aAreaInfo Pointer to a CLbsAreaInfoBase type instance. KErrArgument if the pointer to CLbsAreaInfoBase type is NULL

Retrieves the area information that is stored in the internal data structure. Client applications can specify the type of information to be retrieved using the TAreaInfoMask. The result is updated in the instance of RLbsAreaInfoBaseArray. If there is no information stored for the requested type the instance of RLbsAreaInfoBaseArray will not be updated. Client applications would need to check the contents of the array to determine the information retrieved.

Parameters:
[out] aAreaInfoArray Array that is filled with pointers to the area information retrieved. Note it is the callers responsibility to call Close() to free the pointers. However ownership of the objects pointed to is not transferred to the caller.
[in] aLocInfoMask Specifies the type of information to be retrieved.

Removes all entries of the specified type from the data structure. If the mask is not specified all entries would be removed. If there are no entries found for a specific type, no changes will be done.

Parameters:
[in] aLocInfoMask Specifies the type of information to be removed.

Type of location info class

Internalize method to write location information to a stream.

Externalize method to read location information from a stream.

C++ default constructor

Copy constructor. Prohibited by default.

Overloaded assignment operator. Prohibited by default.

Symbian 2 phase constructor

A collection of geographical area information.


Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. These materials are provided under the terms of the Eclipse Public License v1.0.