#include <mw/EPos_CPosLandmark.h>
| class CPosLandmark : public CBase |
| Public Member Type Definitions | |
|---|---|
| typedef | TUint32 TAttributes |
| Public Member Enumerations | |
|---|---|
| enum | _TAttributes { ENoAttribute, ELandmarkName, EPosition, ECoverageRadius, ..., EAllAttributes } |
This is a container class for a landmark.
A landmark is principally a location with a name.
The landmark object can either be created by a client or retrieved from CPosLandmarkDatabase .
A landmark consists of a number of landmark attributes, e.g. landmark name, landmark position, coverage area, etc.
A landmark may also contain generic position fields. These position fields are defined in LbsFieldIds.h. Only text fields are supported.If the client wants to store a non-text field, the value must first be converted to a textual representation. EPositionPlaceId position field added in extension of TPositionFieldId to support Place id EPositionTimeStamp position field added in extension of TPositionFieldId to support TimeStamp
CPosLandmark contains functions for setting and getting landmark attributes and position fields.
Note: CPosLandmark is only a local representation of the landmark. To update the database, call CPosLandmarkDatabase::UpdateLandmarkL (or CPosLandmarkDatabase::AddLandmarkL for a new landmark).
| typedef TUint32 | TAttributes |
Bitmap for specifying a group of landmark attributes. Bit values are defined by _TAttributes .
Specifies a landmark attribute such as landmark name or landmark position.
| IMPORT_C void | AddCategoryL | ( | TPosLmItemId | aCategoryId | ) |
Adds a category to the landmark.
If the specified category has already been added, nothing happens.
| Parameter | Description |
|---|---|
| aCategoryId | The category to add. |
| IMPORT_C TPositionFieldId | FirstPositionFieldId | ( | ) | const |
Returns the first position field contained in the landmark.
This function is used to initiate iteration over the position fields. NextPositionFieldId() is called to continue the iteration.
Returns: The first position field contained by the landmark, or EPositionFieldNone if there are no position fields in the landmark.
| IMPORT_C void | GetCategoriesL | ( | RArray< TPosLmItemId > & | aCategoryIdArray | ) | const |
Retrieves the database item IDs for the categories contained in this landmark.
| Parameter | Description |
|---|---|
| aCategoryIdArray | On return contains the list of this landmark's categories. |
Reads the landmark coverage radius.
Coverage radius is set if the landmark is big, e.g. a city. It defines the size of the area which the landmark represents.
| Parameter | Description |
|---|---|
| aCoverageRadius | On return contains the coverage radius. |
Returns: KErrNone if successful, KErrNotFound if the landmark coverage radius is not set.
Returns the link to the icon associated with the landmark.
Icons are found in icon files. It is referenced by the name of the icon file and the index of the icon within the file.
The landmark is not affected if the icon file is changed or removed. It only contains a link to the icon. This means that the link could be invalid.
| Parameter | Description |
|---|---|
| aIconFileName | The full icon file name. |
| aIconIndex | The index of the icon within the icon file. |
| aIconMaskIndex | The index of the icon mask within the icon file. If no icon mask index is defined KPosLmIconMaskNotUsed is returned. |
Returns: KErrNone if successful, KErrNotFound if the icon is not set.
Reads the description of the landmark.
This function returns error code KErrNotFound if the landmark description is not set in this landmark object. This will be the case if the landmark is read from the database using partial read and landmark description is excluded. Note that if a landmark is fully read from the database, the landmark description is always included. If no description has been set for the landmark in the database, it is set to an empty string "".
| Parameter | Description |
|---|---|
| aLandmarkDescription | On return contains the landmark description. |
Returns: KErrNone if successful, KErrNotFound if the landmark description is not specified.
Reads the name of the landmark.
This function returns error code KErrNotFound if the landmark name is not set in this landmark object. This will be the case if the landmark is read from the database using partial read and landmark name is excluded. Note that if a landmark is fully read from the database, the landmark name will always be included. If no name has been set for the landmark in the database, it will have an empty name string "".
| Parameter | Description |
|---|---|
| aLandmarkName | On return contains the landmark name. |
Returns: KErrNone if successful, KErrNotFound if the landmark name is not specified.
| IMPORT_C TInt | GetPositionField | ( | TPositionFieldId | aFieldId, |
| TPtrC & | aFieldValue | |||
| ) | const | |||
Reads the value of a position field.
| Parameter | Description |
|---|---|
| aFieldId | The position field to read. |
| aFieldValue | On return contains the value of the position field. |
Returns: KErrNone if successful, KErrNotFound if the landmark does not contain the specified position field.
| IMPORT_C TBool | IsPartial | ( | ) | const |
Checks if the landmark is partial.
A client can read partial information about a landmark from the database. This function checks if only partial information is included in the landmark object. Partial landmark can not be used with CPosLandmarkDatabase::UpdateLandmarkL() .
For more about partial landmarks, see CPosLandmarkDatabase::ReadPartialLandmarkLC() .
Returns: EFalse if the landmark contains all the landmark information, otherwise ETrue.
| IMPORT_C TBool | IsPositionFieldAvailable | ( | TPositionFieldId | aFieldId | ) | const |
Checks if the landmark contains a specific position field.
| Parameter | Description |
|---|---|
| aFieldId | The position field. |
Returns: ETrue if the landmark contains the field, otherwise EFalse.
| IMPORT_C TPosLmItemId | LandmarkId | ( | ) | const |
Reads the ID of the landmark entry in the database.
Returns: The ID of the landmark entry in the database, or KPosLmNullItemId if the landmark has not been added to the database yet.
| IMPORT_C CPosLandmark * | NewL | ( | ) | [static] |
Two-phased constructor.
Returns: A new instance of this class.
| IMPORT_C CPosLandmark * | NewL | ( | const CPosLandmark & | aLandmark | ) | [static] |
Two-phased copy constructor.
| Parameter | Description |
|---|---|
| aLandmark | The landmark to copy. |
Returns: A copy of the specified landmark object.
| IMPORT_C CPosLandmark * | NewLC | ( | ) | [static] |
Two-phased constructor.
Returns: A new instance of this class.
| IMPORT_C CPosLandmark * | NewLC | ( | const CPosLandmark & | aLandmark | ) | [static] |
Two-phased copy constructor.
| Parameter | Description |
|---|---|
| aLandmark | The landmark to copy. |
Returns: A copy of the specified landmark object.
| IMPORT_C TPositionFieldId | NextPositionFieldId | ( | TPositionFieldId | aFieldId | ) | const |
Returns the next position field contained in the landmark.
This function is used to iterate the position fields in the landmark. FirstPositionFieldId() is called to get the first ID. This ID is passed to NextPositionFieldId() to obtain the second ID, etc.
If the client specifies an ID which is not contained in the landmark, this function will panic with code EPosInvalidPositionFieldId. It is therefore important that the client does not remove the current field while iterating. If the client still removes the current field, the client must pass the previous field.
| Parameter | Description |
|---|---|
| aFieldId | The last position field which was read. |
Returns: The next position field contained by the landmark, or EPositionFieldNone if there are no more position fields in the landmark.
| IMPORT_C TUint | NumOfAvailablePositionFields | ( | ) | const |
Returns the number of position fields set in the landmark.
Returns: The number of position fields set in the landmark.
| IMPORT_C void | RemoveCategory | ( | TPosLmItemId | aCategoryId | ) |
Removes a category from the landmark.
If the specified category is not in the landmark, nothing happens.
| Parameter | Description |
|---|---|
| aCategoryId | The category to remove |
| IMPORT_C void | RemoveLandmarkAttributes | ( | TAttributes | aAttributes | ) |
Removes landmark attributes from the landmark.
| Parameter | Description |
|---|---|
| aAttributes | A bitmap specifying which landmark attributes to remove. |
| IMPORT_C void | RemovePositionField | ( | TPositionFieldId | aFieldId | ) |
Removes a position field from the landmark.
If the specified position field is not contained in the landmark, nothing will happen.
| Parameter | Description |
|---|---|
| aFieldId | The position field to remove. |
| IMPORT_C void | SetCoverageRadius | ( | TReal32 | aCoverageRadius | ) |
Sets the landmark coverage radius.
Coverage radius is set if the landmark is big, e.g. a city. It defines the size of the area which the landmark represents.
If coverage radius is set to NaN, then the coverage radius will be removed.
| Parameter | Description |
|---|---|
| aCoverageRadius | The coverage radius. |
Associates the landmark with an icon.
Icons are found in icon files. To set an icon, the client must specify the name of the icon file and the index of the icon within the file.
The landmark is not affected if the icon file is changed or removed. It only contains a link to the icon.
| Parameter | Description |
|---|---|
| aIconFileName | The full icon file name. |
| aIconIndex | The index of the icon within the icon file. |
| aIconMaskIndex | The index of the icon mask within the icon file. |
| IMPORT_C void | SetLandmarkDescriptionL | ( | const TDesC & | aLandmarkDescription | ) |
Sets a description for the landmark.
If no description is set for the landmark when it is written to the database, the landmark in the database will have an empty description string "".
| Parameter | Description |
|---|---|
| aLandmarkDescription | The landmark description. |
| IMPORT_C void | SetLandmarkNameL | ( | const TDesC & | aLandmarkName | ) |
Sets the name of the landmark.
If no name is set for the landmark when it is written to the database, the landmark in the database will have an empty name string "".
| Parameter | Description |
|---|---|
| aLandmarkName | The landmark name. |
| IMPORT_C void | SetPlaceIdL | ( | const TDesC & | aPId | ) |
| Parameter | Description |
|---|---|
| aPId | The place id of the landmark |
| IMPORT_C void | SetPositionFieldL | ( | TPositionFieldId | aFieldId, |
| const TDesC & | aFieldValue | |||
| ) | ||||
Sets a position field in the landmark.
| Parameter | Description |
|---|---|
| aFieldId | The position field to set. |
| aFieldValue | The new value for the position field. |
| IMPORT_C void | SetPositionL | ( | const TLocality & | aPosition | ) |
Sets the landmark position.
Latitude and longitude must be set in the position.
Only WGS 84 coordinates are allowed. KPositionDatumWgs84 must be set as datum.
| Parameter | Description |
|---|---|
| aPosition | The landmark position. |
| IMPORT_C void | SetTimeStampL | ( | const TTime | aTimeStamp | ) |
| Parameter | Description |
|---|---|
| aTimeStamp | Timestamp of the landmark(Full date & time) |