CPosLandmarkDatabaseExtended Class Reference

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_cposlandmarkdatabaseextended.h>

Inherits CPosLandmarkDatabase.


Detailed Description

Handle to a landmark database.

This class defines extensions to the functionality of CPosLandmarkDatabase class.

See also:
CPosLandmarkDatabase
Since:
S60 3.2
Dll eposlandmarks.lib.

Public Member Functions

virtual IMPORT_C ~CPosLandmarkDatabaseExtended ()
 Destructor.
IMPORT_C TInt LandmarksCount ()
 Returns total amount of landmarks in the database.
IMPORT_C TInt CategoriesCount ()
 Returns total amount of landmark categories in the database.
virtual CPosLmCategoryManagerCategoryManager ()=0
 Returns reference to category manager instance for this database.

Static Public Member Functions

static IMPORT_C CPosLandmarkDatabaseExtendedOpenL ()
 Opens the default landmark database.
static IMPORT_C CPosLandmarkDatabaseExtendedOpenL (const TDesC &aDatabaseUri)
 Opens a specific landmark database.

Protected Member Functions

virtual voidGetExtension (TUid aExtensionUid)=0
 Returns pointer to extension interface.
IMPORT_C CPosLandmarkDatabaseExtended ()

Constructor & Destructor Documentation

virtual IMPORT_C CPosLandmarkDatabaseExtended::~CPosLandmarkDatabaseExtended  )  [virtual]
 

Destructor.

IMPORT_C CPosLandmarkDatabaseExtended::CPosLandmarkDatabaseExtended  )  [protected]
 

Member Function Documentation

IMPORT_C TInt CPosLandmarkDatabaseExtended::CategoriesCount  ) 
 

Returns total amount of landmark categories in the database.

Returns:
Number of landmark categories in the database or negative error code.
  • KErrNotSupported if not supported in current database.
  • KErrPosLmNotInitialized if database is not yet initialized.
virtual CPosLmCategoryManager& CPosLandmarkDatabaseExtended::CategoryManager  )  [pure virtual]
 

Returns reference to category manager instance for this database.

virtual void* CPosLandmarkDatabaseExtended::GetExtension TUid  aExtensionUid  )  [protected, pure virtual]
 

Returns pointer to extension interface.

Type of the requested extension interface is supplied by caller in aExtensionId.

Ownership of returned object is not transferred to caller, it is kept by implementation.

Parameters:
[in] aExtensionUid Type of requested extension
Returns:
Pointer to extension implementation, or NULL if not supported.
IMPORT_C TInt CPosLandmarkDatabaseExtended::LandmarksCount  ) 
 

Returns total amount of landmarks in the database.

Returns:
Number of landmarks in the database or negative error code:
  • KErrNotSupported if not supported in current database.
  • KErrPosLmNotInitialized if database is not yet initialized.
static IMPORT_C CPosLandmarkDatabaseExtended* CPosLandmarkDatabaseExtended::OpenL const TDesC &  aDatabaseUri  )  [static]
 

Opens a specific landmark database.

This method is the same as CPosLandmarkDatabase::OpenL(const TDesC&).

The client refers to a database by URI. The URI consists of a protocol specifier and the database location: "protocol://location". If the client does not specify a protocol, "file://" will be assumed.

For local landmark databases, the URI consists of the drive and the database file name, e.g. "c:landmarks.ldb". The path cannot be specified by the client. The extension of the database file name must be "ldb" otherwise the client will get the error KErrArgument.

If the client specifies a local database and does not specify the drive letter, e.g. "landmarks.ldb", default database drive will be assumed.

The client takes ownership of the returned database handle.

The database may have to be initialized before it can be used, see IsInitializingNeeded and InitializeL.

This function requires ReadUserData capability.

Parameters:
[in] aDatabaseUri The URI of the database to open.
Returns:
A handle to the open database.
Leave:
KErrArgument Extension of the local database name is not "ldb".
Leave:
KErrNotSupported This extended interface is not supported for specified protocol.
See also:
CPosLandmarkDatabase::OpenL(const TDesC&)

Reimplemented from CPosLandmarkDatabase.

static IMPORT_C CPosLandmarkDatabaseExtended* CPosLandmarkDatabaseExtended::OpenL  )  [static]
 

Opens the default landmark database.

This method is the same as CPosLandmarkDatabase::OpenL().

The client takes ownership of the returned database handle.

The database may have to be initialized before it can be used, see IsInitializingNeeded and InitializeL.

This function requires ReadUserData capability.

Leave:
KErrNotSupported This extended interface is not supported for default database.
Returns:
A handle to the open database.
See also:
CPosLandmarkDatabase::OpenL()

Reimplemented from CPosLandmarkDatabase.


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

Copyright © Nokia Corporation 2001-2007
Back to top