CPosLmPartialReadParameters Class Reference

API published in: S60 3rd Ed

Link against: eposlandmarks.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLandmarkDatabase::OpenL();

CPosLandmarkDatabase::OpenL( const TDesC & aDatabaseUri );

CPosLandmarkDatabase::InitializeL();

CPosLandmarkDatabase::ReadLandmarkLC( TPosLmItemId aLandmarkId );

CPosLandmarkDatabase::LandmarkIteratorL();

CPosLandmarkDatabase::LandmarkIteratorL( const TPosLmSortPref & aSortPref );

CPosLandmarkDatabase::AddLandmarkL( CPosLandmark & aLandmark );

CPosLandmarkDatabase::UpdateLandmarkL( const CPosLandmark & aLandmark );

CPosLandmarkDatabase::RemoveLandmarkL( TPosLmItemId aLandmarkId );

CPosLandmarkDatabase::RemoveLandmarksL( const RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLandmarkDatabase::RemoveAllLandmarksL();

CPosLandmarkDatabase::ReadPartialLandmarkLC( TPosLmItemId aLandmarkId );

CPosLandmarkDatabase::PreparePartialLandmarksL( const RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLandmarkDatabase::SizeL();

CPosLandmarkDatabase::CompactL();

CPosLandmarkDatabase::NotifyDatabaseEvent( TPosLmEvent & aEvent, TRequestStatus & aStatus );

CPosLandmarkDatabase::CancelNotifyDatabaseEvent();

CPosLandmarkDatabase::ImportLandmarksL( CPosLandmarkParser& aLandmarkParser, TTransferOptions aTransferOptions );

CPosLandmarkDatabase::ImportLandmarksL( CPosLandmarkParser& aLandmarkParser, const RArray<TUint>& aLandmarkSelection, TTransferOptions aTransferOptions );

CPosLmCategoryManager::ReadCategoryLC( TPosLmItemId aCategoryId );

CPosLmCategoryManager::CategoryIteratorL( TCategorySortPref aSortPref );

CPosLmCategoryManager::ReferencedCategoryIteratorL( TCategorySortPref aSortPref )

CPosLmCategoryManager::AddCategoryL( CPosLandmarkCategory & aCategory );

CPosLmCategoryManager::UpdateCategoryL( const CPosLandmarkCategory & aCategory );

CPosLmCategoryManager::RemoveCategoryL( TPosLmItemId aCategoryId );

CPosLmCategoryManager::RemoveCategoriesL( const RArray< TPosLmItemId > & aCategoryIdArray );

CPosLmCategoryManager::AddCategoryToLandmarksL( TPosLmItemId aCategoryId, RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLmCategoryManager::RemoveCategoryFromLandmarksL( TPosLmItemId aCategoryId, RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLmCategoryManager::GetCategoryL( const TDesC & aCategoryName );

CPosLmCategoryManager::GetGlobalCategoryL( TPosLmGlobalCategory aGlobalCategory );

CPosLmCategoryManager::ResetGlobalCategoriesL();

The capability WriteUserData is required in:

CPosLandmarkDatabase::AddLandmarkL( CPosLandmark& aLandmark );

CPosLandmarkDatabase::UpdateLandmarkL( const CPosLandmark& aLandmark );

CPosLandmarkDatabase::RemoveLandmarkL( TPosLmItemId aLandmarkId );

CPosLandmarkDatabase::RemoveLandmarksL( const RArray<TPosLmItemId>& aLandmarkIdArray );

CPosLandmarkDatabase::RemoveAllLandmarksL();

CPosLandmarkDatabase::CompactL();

CPosLandmarkDatabase::ImportLandmarksL( CPosLandmarkParser& aLandmarkParser, TTransferOptions aTransferOptions );

CPosLandmarkDatabase::ImportLandmarksL( CPosLandmarkParser& aLandmarkParser, const RArray<TUint>& aLandmarkSelection, TTransferOptions aTransferOptions );

CPosLmCategoryManager::AddCategoryL( CPosLandmarkCategory & aCategory );

CPosLmCategoryManager::UpdateCategoryL( const CPosLandmarkCategory & aCategory );

CPosLmCategoryManager::RemoveCategoryL( TPosLmItemId aCategoryId );

CPosLmCategoryManager::RemoveCategoriesL( const RArray< TPosLmItemId > & aCategoryIdArray );

CPosLmCategoryManager::AddCategoryToLandmarksL( TPosLmItemId aCategoryId, RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLmCategoryManager::RemoveCategoryFromLandmarksL( TPosLmItemId aCategoryId, RArray< TPosLmItemId > & aLandmarkIdArray );

CPosLmCategoryManager::ResetGlobalCategoriesL();

Other Information

The capability NetworkServices is required to work with remote databases.

#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-2008
Back to top