CPosLmItemIterator Class Reference

#include <mw/EPos_CPosLmItemIterator.h>

Link against: eposlandmarks.lib

class CPosLmItemIterator : public CBase

Inherits from

  • CPosLmItemIterator
    Public Member Functions
    virtual ~CPosLmItemIterator()
    pure virtual voidGetItemIdsL(RArray< TPosLmItemId > &, TInt, TInt)
    pure virtual TPosLmItemId NextL()
    pure virtual TUint NumOfItemsL()
    pure virtual voidReset()
    Protected Member Functions
    CPosLmItemIterator()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Landmark item iterator.

    This is an abstract base class for objects which iterates a set of database items in a single database.

    A database item is an item which is stored in a landmark database, i.e. a landmark or a landmark category.

    Note that an iterator either iterates categories or landmarks. The items are never mixed.

    This class does not export a constructor. The instance is created by the operation which generates the item set to be iterated. The iterator may implement a caching scheme, but that scheme depends on what is iterated.

    Since
    S60 3.0

    Constructor & Destructor Documentation

    CPosLmItemIterator ( )

    IMPORT_CCPosLmItemIterator()[protected]

    ~CPosLmItemIterator ( )

    IMPORT_C~CPosLmItemIterator()[virtual]

    Destructor.

    Member Function Documentation

    GetItemIdsL ( RArray< TPosLmItemId > &, TInt, TInt )

    voidGetItemIdsL(RArray< TPosLmItemId > &aIdArray,
    TIntaStartIndex,
    TIntaNumOfItems
    )[pure virtual]

    Fetches a sequence of database items from the iterated set.

    The client supplies an ID array which will be filled by this operation. The array will be reset before any items are added.

    The client specifies which database item sequence to fetch by supplying a start index (0 is the first item) and the number of items to fetch.

    panic
    "Landmarks Client"-EPosSpecifiedIntervalLiesOutsideIteratedSet specified interval lies [partially] outside the iterated set.
    ParameterDescription
    aIdArrayOn return contains the requested items.
    aStartIndexThe index of the first item to fetch.
    aNumOfItemsThe number of items to fetch

    NextL ( )

    TPosLmItemId NextL()[pure virtual]

    Returns the next database item ID in the iterated set.

    The first call will return the first database item ID in the set.

    Returns: The next database item ID, or KPosLmNullItemId if there are no more database items in the iterated set.

    NumOfItemsL ( )

    TUint NumOfItemsL()[pure virtual]

    Returns the number of database items which are iterated.

    Returns: Number of items in the iterated database item set.

    Reset ( )

    voidReset()[pure virtual]

    Resets the database item iterator.

    The next call to NextL will return the first database item ID in the iterated set.

    © Nokia 2011.