RLbsLocInfoConverter Class Reference

#include <rlbslocinfoconverter.h>

List of all members.

Public Member Functions

IMPORT_C RLbsLocInfoConverter ()
IMPORT_C ~RLbsLocInfoConverter ()
IMPORT_C void OpenL (RLbsLocMonitorSession &aLocMonSession)
IMPORT_C void Close ()
IMPORT_C void ConvertLocationInfoL (CLbsLocationInfoBase &aLocationInfo, TLbsConversionPrefs aConversionPrefs, const TLbsConversionOutputInfoMask &aRequestedInfo, const TUid aConverterModuleId, TRequestStatus &aStatus)
IMPORT_C void ConvertLocationInfoL (RLbsLocationInfoBaseArray &aLocationInfoArray, TLbsConversionPrefs aConversionPrefs, TLbsConversionOutputInfoMask aRequestedInfo, const TUid aConverterModuleId, TRequestStatus &aStatus)
IMPORT_C void CancelConvertLocationInfo ()
void HandleSingleConversionBufferSizeL ()
void HandleMultipleConversionBufferSizeL ()
void ValidateLocationInfoL (CLbsLocationInfoBase *aLocationInfo)

Detailed Description

This class provides services pertaining to conversion of geographical area information represented as a collection of GSM/WCDMA or WLAN information to corresponding geographical coordinates. This class is used to create sub-session with the location monitor server.

Before using the class, a primary connection must have already been established with the server with RLbsLocMonitorSession::Connect().


Constructor & Destructor Documentation

EXPORT_C RLbsLocInfoConverter::RLbsLocInfoConverter (  ) 

C++ constructor

EXPORT_C RLbsLocInfoConverter::~RLbsLocInfoConverter (  ) 

Destructor


Member Function Documentation

EXPORT_C void RLbsLocInfoConverter::CancelConvertLocationInfo (  ) 

Cancel outstanding request to convert location information.

EXPORT_C void RLbsLocInfoConverter::Close (  ) 

Closes the subsession with Location Monitor Server.

EXPORT_C void RLbsLocInfoConverter::ConvertLocationInfoL ( RLbsLocationInfoBaseArray &  aLocationInfoArray,
TLbsConversionPrefs  aConversionPrefs,
TLbsConversionOutputInfoMask  aRequestedInfo,
const TUid  aConverterModuleId,
TRequestStatus &  aStatus 
)

Converts the area informations of a group of geographical locations to its corresponding position information.

Parameters:
[in] aLocationInfoArray Array of Location information to be converted.
[in] aConversionPrefs Conversion preferences suggested by client.
[in] aRequestedInfo Location information that is requested.
[in] aConversionModuleId Module ID of the converter plugin to be used
[out] aStatus Contains the error code when the request is completed.

KErrArgument If the location info array is empty or if array count exceeds KPositionMaxBatchSize or one of system wide error codes.

EXPORT_C void RLbsLocInfoConverter::ConvertLocationInfoL ( CLbsLocationInfoBase &  aLocationInfo,
TLbsConversionPrefs  aConversionPrefs,
const TLbsConversionOutputInfoMask aRequestedInfo,
const TUid  aConverterModuleId,
TRequestStatus &  aStatus 
)

Converts one area info to position info

Parameters:
[in] aLocationInfo location information corresponding to a geographical location is passed and on successful completion of this method,position information corresponding to the location information is returned in the observer callback.
[in] aConversionPrefs Conversion preferences suggested by client
[in] aRequestedInfo Location information that is requested.
[in] aConverterModuleId Module ID of the converter plugin to be used
[out] aStatus Contains the error code when the request is completed.

KErrArgument If the location info pointer is NULL or one of system wide error codes.

void RLbsLocInfoConverter::HandleMultipleConversionBufferSizeL (  ) 

Handles buffer size passed from the server to store multiple converted location info.

void RLbsLocInfoConverter::HandleSingleConversionBufferSizeL (  ) 

Handles buffer size passed from the server to store single converted location info.

EXPORT_C void RLbsLocInfoConverter::OpenL ( RLbsLocMonitorSession aLocMonSession  ) 

Opens a subsession with Location Monitor Server.

A subsession must be opened before any other service can be used.

Parameters:
[in] aServer Reference to the Location Monitor Server session.
Returns:
KErrNone if successful. Otherwise, Symbian standard error code is returned, such as KErrNoMemory, KErrServerBusy, etc.
void RLbsLocInfoConverter::ValidateLocationInfoL ( CLbsLocationInfoBase *  aLocationInfo  ) 

Validates location information.


The documentation for this class was generated from the following files:

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.