TLmkItemIdDbCombiInfo Class Reference

#include <app/TLmkItemIdDbCombiInfo.h>

Link against: LmkCommonUiStub.lib

class TLmkItemIdDbCombiInfo

Detailed Description

This class provides methods for fetching the ID of selected landmark or category and the handle to database to which either landmark or category belongs.

Constructor & Destructor Documentation

TLmkItemIdDbCombiInfo ( )

IMPORT_CTLmkItemIdDbCombiInfo()

C++ default constructor.

Returns: newly instantiated object

~TLmkItemIdDbCombiInfo ( )

IMPORT_C~TLmkItemIdDbCombiInfo()

Destructor.

Member Function Documentation

GetItemId ( )

IMPORT_C TPosLmItemIdGetItemId()const

The client application executes this method to get the ID of a landmark or category

Returns: id of the landmark or category

GetLmDb ( )

IMPORT_C CPosLandmarkDatabase *GetLmDb()const

The client application executes this method to get the handle to a landmark database. The client takes the ownership of database handle. The database pointer is the same for all landmarks from the same database. It is the responsibilty of the API client to manage these database pointers and delete those pointers.

Returns: handle to database to which the landmark or category belongs

SetItemId ( TPosLmItemId & )

IMPORT_C voidSetItemId(TPosLmItemId &aLmItemId)

This function is used to set the landmark or category id to the object of this class. Basically this function is used by the API implementation logic.

ParameterDescription
aLmItemIdwill contain reference to id of landmark or category

SetLmDb ( CPosLandmarkDatabase * )

IMPORT_C voidSetLmDb(CPosLandmarkDatabase *aDb)

This function is used to set the landmark database handle to the object of this class. Objects of this class owns the database handle.Basically this function is used by the API implementation logic.

ParameterDescription
aDbcontains the pointer to database handle