| class CPosLandmarkDatabase : public CBase |
Handle to a landmark database.
This class contains functions for creating, iterating, reading, modifying and deleting landmarks.
Operations on the database may fail with error code KErrCorrupt if the database is damaged. The client can try to recover the database by calling CPosLandmarkDatabase::InitializeL() .
Operations on the database may fail with error code KErrLocked if another client is writing to the database. Write operations can also fail with this error code if another client is currently reading from the database.
If CPosLandmarkDatabase is used, the client must call the global function ReleaseLandmarkResources() before terminating in order to release all used landmark resources, otherwise the client may receive an ALLOC panic.
NetworkServices capability is required for remote databases.
S60 3.0 eposlandmarks.lib.
| Protected Member Functions | |
|---|---|
| CPosLandmarkDatabase() | |
| Private Member Functions | |
|---|---|
| CPosLandmarkDatabase(const CPosLandmarkDatabase &) | |
| CPosLandmarkDatabase & | operator=(const CPosLandmarkDatabase &) |
| Public Member Enumerations | |
|---|---|
| enum | _TTransferOptions { EDefaultOptions = 0, EIncludeCategories = 0x01, EIncludeGlobalCategoryNames = 0x02, ESupressCategoryCreation = 0x04 } |
| Public Member Type Definitions | |
|---|---|
| typedef | TUint TTransferOptions |
| Protected Attributes | |
|---|---|
| TUid | iDtorIdKey |
| CPosLandmarkDatabase | ( | const CPosLandmarkDatabase & | ) | [private] |
| const CPosLandmarkDatabase & |
| TPosLmItemId | AddLandmarkL | ( | CPosLandmark & | aLandmark | ) | [pure virtual] |
Adds a new landmark to the database and returns its ID.
Database is initialized (see IsInitializingNeeded ).
A landmark can contain the IDs of the categories it belongs to. If any of these categories does not exist in the database, the add operation will still complete successfully but the category which was not found will be ignored.
This function requires ReadUserData and WriteUserData capabilities.
Landmark is added to the database and landmark object has database item set (CPosLandmark::LandmarkId()).
The ID of the new landmark.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| CPosLandmark & aLandmark | The landmark to add. |
| TInt | CancelNotifyDatabaseEvent | ( | ) | [pure virtual] |
Cancels a call to NotifyDatabaseEvent .
This function requires ReadUserData capability.
KErrNone if the request was successfully cancelled, otherwise a system wide error code.
| CPosLmOperation * | CompactL | ( | ) | [pure virtual] |
Compacts the landmark database.
Database is initialized (see IsInitializingNeeded ).
Compaction means that any unused space in the database is removed.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
The client takes ownership of the returned operation object.
This function requires ReadUserData and WriteUserData capabilities.
A handle to the operation.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| HBufC * | DatabaseUriLC | ( | ) | [pure virtual] |
Returns a URI which points to the landmark database storage.
The URI may point to a file in the terminal file system or on a remote file.
The client takes ownership of the returned descriptor.
The database URI. The URI is put on the cleanup stack.
| CPosLmOperation * | ExportLandmarksL | ( | CPosLandmarkEncoder & | aLandmarkEncoder, |
| const RArray< TPosLmItemId > & | aLandmarkIdArray, | |||
| TTransferOptions | aTransferOptions | |||
| ) | [pure virtual] | |||
Exports a number of landmarks.
Database is initialized (see IsInitializingNeeded ).
To export a set of landmarks, the client must first create a CPosLandmarkEncoder object for the landmark content format in which the landmarks should be encoded. The client can add some information of the landmark collection in the encoder as well.
The client must also provide a list of the landmarks which should be exported. If one of the landmarks are not found in the database, the returned operation fails with error code KErrNotFound.
The client does not have to add any landmarks to the encoder object. This function will add the ones specified in the ID array.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that only a subset of the landmarks have been exported.
The client takes ownership of the returned operation object.
When all landmarks have been exported the client must finalize encoding by calling CPosLandmarkEncoder::FinalizeEncodingL .
This function requires ReadUserData capability.
A handle to the operation.
leave
KErrPosLmNotInitialized Database is not yet initialized.
panic
"Landmarks Client"-EPosLmInvalidArgument Client specified invalid transfer option values.
| CPosLandmarkEncoder & aLandmarkEncoder | A landmark encoder object. |
| const RArray< TPosLmItemId > & aLandmarkIdArray | The landmarks which should be exported. |
| TTransferOptions aTransferOptions | A bitmap representing the options for the export operation. The bitmap values are defined by _TTransferOptions . |
| CPosLmOperation * | ImportLandmarksL | ( | CPosLandmarkParser & | aLandmarkParser, |
| TTransferOptions | aTransferOptions | |||
| ) | [pure virtual] | |||
Import a set of landmarks.
Database is initialized (see IsInitializingNeeded ).
To import landmark content, the client must first create a parser object which can parse the landmark content. The client does not have to call CPosLandmarkParser::ParseContentL first. If the content is not already parsed, this will be handled by the import operation.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that only a subset of the landmarks have been imported.
The client takes ownership of the returned operation object.
After completion ImportedLandmarksIteratorL can be called to retrieve the IDs of the added landmarks.
The NextStep function in the operation object cannot be executed synchronously using User::WaitForRequest. Doing so may cause the operation to hang. NextStep must be run using an active object for this operation.
This function requires ReadUserData and WriteUserData capabilities.
A handle to the operation.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
panic
"Landmarks Client"-EPosLmInvalidArgument Client specified invalid transfer option values.
| CPosLandmarkParser & aLandmarkParser | An object which can parse landmark content. |
| TTransferOptions aTransferOptions | A bitmap representing the options for the import operation. The bitmap values are defined by _TTransferOptions . |
| CPosLmOperation * | ImportLandmarksL | ( | CPosLandmarkParser & | aLandmarkParser, |
| const RArray< TUint > & | aLandmarkSelection, | |||
| TTransferOptions | aTransferOptions | |||
| ) | [pure virtual] | |||
Import a set of landmarks.
Database is initialized (see IsInitializingNeeded ).
To import landmark content, the client must first create a parser object which can parse the landmark content. The client does not have to call CPosLandmarkParser::ParseContentL first. If the content is not already parsed, this will be handled by the import operation.
In this overload of the function, the client can pass an array defining a subset of the landmarks in the parser object. This way the client can select to import only a part of the landmark content.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that only a subset of the landmarks have been imported.
The client takes ownership of the returned operation object.
After completion ImportedLandmarksIteratorL can be called to retrieve the IDs of the added landmarks.
The NextStep function in the operation object cannot be executed synchronously using User::WaitForRequest. Doing so may cause the operation to hang. NextStep must be run using an active object for this operation.
This function requires ReadUserData and WriteUserData capabilities.
A handle to the operation.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
panic
"Landmarks Client"-EPosLmInvalidArgument Client specified invalid transfer option values.
| CPosLandmarkParser & aLandmarkParser | An object which can parse landmark content. |
| const RArray< TUint > & aLandmarkSelection | An array defining which of the parsed landmarks to import. The array items refer to the order in which CPosLandmarkParser accesses the landmarks. 0 means the first parsed landmark, 1 means the second, etc. If the parser supports indexing, these numbers correspond to the index values used to access the landmarks in CPosLandmarkParser::LandmarkLC . The index values must be less than the number of landmarks accessed by the parser, otherwise the operation object will panic with error code EPosInvalidIndex during execution. Note: The indexes can be used regardless of whether the parser supports indexing or not. |
| TTransferOptions aTransferOptions | A bitmap representing the options for the import operation. The bitmap values are defined by _TTransferOptions . |
| CPosLmItemIterator * | ImportedLandmarksIteratorL | ( | CPosLmOperation * | aImportOperation | ) | [pure virtual] |
Returns an object for iterating the landmarks added in an import operation.
To import landmarks ImportLandmarksL is used.
If ImportedLandmarksIteratorL is called before the ImportLandmarksL operation has completed, the iterator will iterate the landmarks imported so far. Landmarks imported after the iterator is obtained will not affect the iterator. A new iterator must be obtained to iterate these new landmarks.
The client takes ownership of the returned iterator object.
An object for iterating the landmarks added in the latest import operation.
| CPosLmOperation * aImportOperation | This object is returned by ImportLandmarksL methods. |
| CPosLmOperation * | InitializeL | ( | ) | [pure virtual] |
Initializes the database.
This function may have to be called right after the database is opened. IsInitializingNeeded can be called to find out if initialization is needed.
If the database becomes damaged, the client can call InitializeL to try to recover the database.
It is ok to call even if initialization is not needed. In this case, the operation will not do anything.
If the database needs to be initialized, the client must call InitializeL , otherwise the database may not be possible to access. Access functions may leave with KErrPosLmNotInitialized.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that the database is not yet initialized.
The client takes ownership of the returned operation object.
This function requires ReadUserData capability.
A handle to the operation.
| TBool | IsInitializingNeeded | ( | ) | const [pure virtual] |
Checks if the database is in need of initialization.
If the database needs to be initialized, the client must call InitializeL , otherwise the database may not be possible to access. Access functions may leave with KErrPosLmNotInitialized.
Initialization may be needed also if the database becomes damaged. The client can then try to call InitializeL to try to recover the database.
ETrue if the database is in need of initialization, otherwise EFalse.
| CPosLmItemIterator * | LandmarkIteratorL | ( | ) | [pure virtual] |
Returns an object for iterating the landmarks in the database.
Database is initialized (see IsInitializingNeeded ).
The iterator object is reset, so that the first CPosLmItemIterator::NextL call will return the first landmark ID.
The client takes ownership of the returned iterator object.
This function requires ReadUserData capability.
The landmark iterator.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| CPosLmItemIterator * | LandmarkIteratorL | ( | const TPosLmSortPref & | aSortPref | ) | [pure virtual] |
Returns an object for iterating the landmarks in the database.
Database is initialized (see IsInitializingNeeded ).
The iterator object is reset, so that the first CPosLmItemIterator::NextL call will return the first landmark ID.
This overload of the iterator function takes a sort preference object as input. The sort preference object specifies how the landmarks should be sorted by the iterator. Only sorting by landmark name is supported.
The client takes ownership of the returned iterator object.
This function requires ReadUserData capability.
The landmark iterator.
leave
KErrNotSupported Sorting by another attribute than name is requested.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| const TPosLmSortPref & aSortPref | A sort preference object. |
| void | NotifyDatabaseEvent | ( | TPosLmEvent & | aEvent, |
| TRequestStatus & | aStatus | |||
| ) | [pure virtual] | |||
Listens for database events.
This function is asynchronous and it will complete the request status when an event occurs. At this time aEvent input parameter is updated and the client can read event information from it.
Event listening can be cancelled by calling CancelNotifyDatabaseEvent .
This function requires ReadUserData capability.
panic
"Landmarks Client"-EPosEventNotifierAlreadyHasOutstandingRequest Client already has an outstanding NotifyDatabaseEvent request.
| TPosLmEvent & aEvent | Upon completion contains the event information. |
| TRequestStatus & aStatus | Upon completion contains status of the request. KErrNotSupported if events are not supported. KErrNone if an event occured, otherwise an error code if some error was encountered. |
| IMPORT_C CPosLandmarkDatabase * | OpenL | ( | ) | [static] |
Opens the default landmark database.
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.
A handle to the open database.
| IMPORT_C CPosLandmarkDatabase * | OpenL | ( | const TDesC & | aDatabaseUri | ) | [static] |
Opens a specific landmark database.
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.
A handle to the open database.
leave
KErrArgument Extension of the local database name is not "ldb".
leave
KErrNotSupported The protocol specified in URI is not supported.
| const TDesC & aDatabaseUri | The URI of the database to open. |
| CPosLmPartialReadParameters * | PartialReadParametersLC | ( | ) | [pure virtual] |
Returns the partial read parameters for this database handle.
Partial read parameters are used to define which landmark data should be returned when ReadPartialLandmarkLC is called.
The client takes ownership of the returned parameter object.
The current partial read parameters.
| CPosLmOperation * | PreparePartialLandmarksL | ( | const RArray< TPosLmItemId > & | aLandmarkIdArray | ) | [pure virtual] |
Reads partial data from a set of landmarks in the database.
Database is initialized (see IsInitializingNeeded ).
Partial settings define which landmark data should be read. Partial read attributes are defined by calling SetPartialReadParametersL . If no partial read parameters have been set, the landmarks will not contain any attributes.
Note that the returned data may be very big if all attributes in each landmark are requested. A typical use for this function is to retrieve the names for a set of landmarks.
When the request is completed, the result can be retrieved by calling TakePreparedPartialLandmarksL .
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
The client takes ownership of the returned operation object.
While preparing landmark information, this operation will acquire a read-lock on the database.
This function requires ReadUserData capability.
A handle to the operation.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| const RArray< TPosLmItemId > & aLandmarkIdArray | An array with IDs of the landmarks to read. |
| CPosLandmark * | ReadLandmarkLC | ( | TPosLmItemId | aLandmarkId | ) | [pure virtual] |
Reads a landmark from the database.
Database is initialized (see IsInitializingNeeded ).
The client takes ownership of the returned database landmark object.
This function requires ReadUserData capability.
The requested landmark. The landmark object is put on the cleanup stack.
leave
KErrNotFound The requested landmark does not exist in the database.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| TPosLmItemId aLandmarkId |
| CPosLandmark * | ReadPartialLandmarkLC | ( | TPosLmItemId | aLandmarkId | ) | [pure virtual] |
Reads partial data from a landmark in the database.
Database is initialized (see IsInitializingNeeded ).
Partial settings define which landmark data should be returned in this call. Partial read attributes are defined by calling SetPartialReadParametersL . If no partial read parameters have been set, the landmarks will not contain any attributes.
The client takes ownership of the returned landmark object.
This function requires ReadUserData capability.
The requested landmark. The landmark object will only contain the attributes defined in the partial read attributes. The landmark object is put on the cleanup stack.
leave
KErrNotFound The requested landmark does not exist in the database.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| TPosLmItemId aLandmarkId |
| CPosLmOperation * | RemoveAllLandmarksL | ( | ) | [pure virtual] |
Removes all landmarks from the database.
Database is initialized (see IsInitializingNeeded ).
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that only a subset of the landmarks have been deleted.
The client takes ownership of the returned operation object.
While removing landmarks, this operation will acquire a write-lock on the database.
This function requires ReadUserData and WriteUserData capabilities.
A handle to the operation.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| void | RemoveLandmarkL | ( | TPosLmItemId | aLandmarkId | ) | [pure virtual] |
Removes a landmark from the database.
Database is initialized (see IsInitializingNeeded ).
If the landmark does not exist in the database, nothing happens.
This function requires ReadUserData and WriteUserData capabilities.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| TPosLmItemId aLandmarkId | The ID of the landmark to remove. |
| CPosLmOperation * | RemoveLandmarksL | ( | const RArray< TPosLmItemId > & | aLandmarkIdArray | ) | [pure virtual] |
Removes a set of landmarks from the database.
Database is initialized (see IsInitializingNeeded ).
If any of the specified landmarks don't exist in the database, nothing happens for those landmarks.
The function returns an operation object which can be run in incremental mode. If it is run incrementally the client can supervise the progress of the operation.
If the CPosLmOperation object is deleted before the operation is complete, it is possible that only a subset of the landmarks have been deleted.
The client takes ownership of the returned operation object.
While removing landmarks, this operation will acquire a write-lock on the database.
This function requires ReadUserData and WriteUserData capabilities.
A handle to the operation.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| const RArray< TPosLmItemId > & aLandmarkIdArray | The IDs of the landmarks to remove. |
| void | SetPartialReadParametersL | ( | const CPosLmPartialReadParameters & | aPartialSettings | ) | [pure virtual] |
Sets the partial read parameters for this database handle.
Partial read parameters are used to define which landmark data should be returned when ReadPartialLandmarkLC is called.
| const CPosLmPartialReadParameters & aPartialSettings | The new partial read parameters. |
| TSize | SizeL | ( | ) | [pure virtual] |
Returns size information for the database.
This function requires ReadUserData capability.
Size information for the database.
| CArrayPtr< CPosLandmark > * | TakePreparedPartialLandmarksL | ( | CPosLmOperation * | aPreparePartialLandmarkOperation | ) | [pure virtual] |
Fetches the result from a call to PreparePartialLandmarksL .
A call to this function must be preceeded by successful call to PreparePartialLandmarksL .
The returned array will have the same length as the ID array passed in the PreparePartialLandmarksL call and it will have the same order.
If reading a landmark failed during preparation, the corresponding pointer value in the returned array will be NULL. For instance, reading can fail if the specified ID does not exist in the database.
The client takes ownership of the returned array object including the contained landmark objects.
An array containing the prepared partial landmark objects.
leave
KErrNotFound PreparePartialLandmarksL hasn't been called yet or it didn't succeed or this function has been called already since then.
| CPosLmOperation * aPreparePartialLandmarkOperation | The operation object returned by the PreparePartialLandmarksL function. |
| void | UpdateLandmarkL | ( | const CPosLandmark & | aLandmark | ) | [pure virtual] |
Updates a landmark in the database.
Database is initialized (see IsInitializingNeeded ).
Only landmark objects containing full landmark information can be used to update a landmark. If a partial landmark (see ReadPartialLandmarkLC and CPosLandmark::IsPartial ) is passed to this function it will leave with KErrArgument.
Note that any updates in the database made since the landmark object was read from the database will be overwritten by this operation.
A landmark can contain the IDs of the categories it belongs to. If any of these categories does not exist in the database, the update operation will still complete successfully but the category which was not found will be ignored.
This function requires ReadUserData and WriteUserData capabilities.
leave
KErrArgument A partial landmark is passed.
leave
KErrAccessDenied The database is read-only.
leave
KErrPosLmNotInitialized Database is not yet initialized.
| const CPosLandmark & aLandmark | The new landmark data. |
| CPosLandmarkDatabase & | operator= | ( | const CPosLandmarkDatabase & | ) | [private] |
| const CPosLandmarkDatabase & |
Specifies options for importing and exporting landmarks.
| EDefaultOptions = 0 |
None of the transfer option flags are set. |
| EIncludeCategories = 0x01 |
Export/Import the categories of the landmarks. |
| EIncludeGlobalCategoryNames = 0x02 |
Only useful in combination with EIncludeCategories. If set, global category names will be used in export/import even if user has renamed them. For import it means that the names of the global categories in the database are overwritten by the imported names. For export it means that predefined names of global categories in the current language will be exported instead of user-defined names. |
| ESupressCategoryCreation = 0x04 |
Only useful in combination with EIncludeCategories. If set, no new categories are created in the database when importing landmarks. This means that connections from imported landmarks will be established only to already existing categories, according to the import information. |
| typedef TUint | TTransferOptions |
Bitmap for specifying a group of transfer options defined by _TAttributes .