S60 3rd Edition API Reference: CPosLmPartialReadParameters Class Reference

CPosLmPartialReadParameters Class Reference

API published in: S60 3rd Ed

Link against: eposlandmarks.lib

Capability Information

Required Capabilities

LocalServices NetworkServices ReadDeviceData ReadUserData WriteDeviceData WriteUserData

#include <epos_cposlmpartialreadparameters.h>

Detailed Description

Container class for partial landmark settings.

Partial settings are used to define which landmark data should be returned when CPosLandmarkDatabase::ReadPartialLandmarkLC is called.


Public Member Functions

virtual ~CPosLmPartialReadParameters ()
 Destructor.
IMPORT_C CPosLandmark::TAttributes RequestedAttributes () const
 Returns a bitmap of the landmark attributes which should be included in a partial landmark.
IMPORT_C void SetRequestedAttributes (CPosLandmark::TAttributes aAttributes)
 Sets a bitmap of the landmark attributes which should be included in a partial landmark.
IMPORT_C TInt GetRequestedPositionFields (RArray< TUint > &aRequestedFields) const
 Returns the position fields which should be included in a partial landmark.
IMPORT_C TInt SetRequestedPositionFields (const RArray< TUint > &aRequestedFields)
 Sets the position fields which should be included in a partial landmark.

Static Public Member Functions

static IMPORT_C CPosLmPartialReadParameters * NewLC ()
 Two-phased constructor.

Constructor & Destructor Documentation

virtual CPosLmPartialReadParameters::~CPosLmPartialReadParameters (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C TInt CPosLmPartialReadParameters::GetRequestedPositionFields ( RArray< TUint > &  aRequestedFields  )  const
 

Returns the position fields which should be included in a partial landmark.

Parameters:
[out] aRequestedFields Will contain the requested position fields, i.e. TPositionFieldId.
Returns:
KErrNone if successful, otherwise one of the system wide error codes.
static IMPORT_C CPosLmPartialReadParameters* CPosLmPartialReadParameters::NewLC (   )  [static]
 

Two-phased constructor.

Returns:
A new instance of this class.
IMPORT_C CPosLandmark::TAttributes CPosLmPartialReadParameters::RequestedAttributes (   )  const
 

Returns a bitmap of the landmark attributes which should be included in a partial landmark.

The bitmap is a combination of the values in CPosLandmark::TAttribute.

Returns:
The partial landmark attributes bitmap.
IMPORT_C void CPosLmPartialReadParameters::SetRequestedAttributes ( CPosLandmark::TAttributes  aAttributes  ) 
 

Sets a bitmap of the landmark attributes which should be included in a partial landmark.

The bitmap is constructed from the values in CPosLandmark::TAttribute.

Parameters:
[in] aAttributes A partial landmark attributes bitmap.
IMPORT_C TInt CPosLmPartialReadParameters::SetRequestedPositionFields ( const RArray< TUint > &  aRequestedFields  ) 
 

Sets the position fields which should be included in a partial landmark.

Parameters:
[in] aRequestedFields The requested position fields, i.e. TPositionFieldId.
Returns:
KErrNone if successful, otherwise one of the system wide error codes.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top