CLbsLocationInfoConverter Class Reference

#include <lbslocationinfoconverter.h>

List of all members.

Public Member Functions

IMPORT_C ~CLbsLocationInfoConverter ()
IMPORT_C void ConvertLocationInfoL (CLbsLocationInfoBase &aLocationInfo, const TLbsConversionPrefs aConversionPrefs, const TLbsConversionOutputInfoMask aRequestedInfo)
IMPORT_C void ConvertLocationInfoL (RLbsLocationInfoBaseArray &aLocationInfoArray, const TLbsConversionPrefs aConversionPrefs, const TLbsConversionOutputInfoMask aRequestedInfo)
IMPORT_C void CancelConvertLocationInfo ()

Static Public Member Functions

static IMPORT_C
CLbsLocationInfoConverter
NewL (MLbsLocationInfoConverterObserver &aObserver, const TUid aConverterModuleId)
static IMPORT_C
CLbsLocationInfoConverter
NewL (MLbsLocationInfoConverterObserver &aObserver)

Detailed Description

The CLbsLocationInfoConverter interface is used in partnership with MLbsLocationInfoConverterObserver and provides the services to convert location information between different formats.

Completion of conversions is indicated by the LBS subsystem by invoking callbacks defined by the MLbsLocationInfoConverterObserver class.

Currently the only supported conversion is from WLAN and/or GSM and/or WCDMA info into a geographic Locality.


Constructor & Destructor Documentation

EXPORT_C CLbsLocationInfoConverter::~CLbsLocationInfoConverter (  ) 

Destructor.


Member Function Documentation

EXPORT_C void CLbsLocationInfoConverter::CancelConvertLocationInfo (  ) 

Cancels an ongoing conversion operation. If there is no ongoing conversion the cancellation request is ignored.

Neither of the The MLbsLocationInfoConverterObserver callbacks will not be invoked if cancellation is successful.

EXPORT_C void CLbsLocationInfoConverter::ConvertLocationInfoL ( RLbsLocationInfoBaseArray &  aLocationInfoArray,
const TLbsConversionPrefs  aConversionPrefs,
const TLbsConversionOutputInfoMask  aRequestedInfo 
)

A general purpose function that converts multiple locationinfos. The maximum allowable batch size is defined by KPositionMaxBatchSize which is 500. Exceeding KPositionMaxBatchSize will result in KErrNotSupported being reported.

Completion of the conversion is indicated by the LBS subsystem by invoking the MLbsLocationInfoConverterObserver::OnConversionComplete and the caller can then iterate through the results returned in aLocationInfoArray

Location

Parameters:
[in] aLocationInfo An array of location information to be converted.
[in] aConversionPrefs Conversion preferences suggested by client
[in] aRequestedInfo Location information that is requested. Currently the only supported conversion is from WLAN and/or GSM and/or WCDMA info into a geographic position, hence the parameter should be set to ELbsConversionOutputPosition)

KErrNoMemory if there is not enough memory available to perform the conversion. KErrArgument If the location info pointer is NULL. KErrNotSupported if the conversion type specified by aRequestedInfo is not supported or if the bitmask specified by the client has all options set. This error is also returned if the batch size exceeds KPositionMaxBatchSize.

EXPORT_C void CLbsLocationInfoConverter::ConvertLocationInfoL ( CLbsLocationInfoBase &  aLocationInfo,
const TLbsConversionPrefs  aConversionPrefs,
const TLbsConversionOutputInfoMask  aRequestedInfo 
)

A general purpose function that converts a single locationinfo. Completion of the conversion is indicated by the LBS subsystem by invoking the MLbsLocationInfoConverterObserver::OnConversionComplete and the caller can then iterate through the results returned in aLocationInfo

Location

Parameters:
[in] aLocationInfo location information to be converted.
[in] aConversionPrefs Conversion preferences suggested by client
[in] aRequestedInfo Location information that is requested. Currently the only supported conversion is from WLAN and/or GSM and/or WCDMA info into a geographic position, hence the parameter should be set to ELbsConversionOutputPosition) Need to say that can only do one of either ConvertLocationFingerPrintToLocalityL or ConvertLocationInfoL at a time or else user is panicked

KErrNoMemory if there is not enough memory available to perform the conversion. KErrArgument If the location info pointer is NULL.

EXPORT_C CLbsLocationInfoConverter * CLbsLocationInfoConverter::NewL ( MLbsLocationInfoConverterObserver aObserver  )  [static]

Allocates and construct a new CLbsLocationInfoConverter Note here to say that impementations for both OnResolveLocationComplete and OnConversionComplete MUST be provided even though only interested in say, ConvertLocationFingerPrintToLocalityL Opens the default module.

Parameters:
[in] aObserver An observer for location conversion event.
EXPORT_C CLbsLocationInfoConverter * CLbsLocationInfoConverter::NewL ( MLbsLocationInfoConverterObserver aObserver,
const TUid  aConverterModuleId 
) [static]

Allocates and construct a new CLbsLocationInfoConverter

Parameters:
[in] aObserver An observer for location conversion event.
[in] aConverterModuleId UID of the conversion plugin to be used.

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.