Collapse all Symbian^3 Product Developer Library

CPosLmItemIterator Class Reference

class CPosLmItemIterator : public CBase

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.

eposlandmarks.lib

Since: S60 3.0

Inherits from

CPosLmItemIterator
- CBase

Public Member Functions
	~CPosLmItemIterator()
void	GetItemIdsL(RArray< TPosLmItemId > &, TInt, TInt)
TPosLmItemId	NextL()
TUint	NumOfItemsL()
void	Reset()

Protected Member Functions
	CPosLmItemIterator()

Private Member Functions
	CPosLmItemIterator(const CPosLmItemIterator &)
CPosLmItemIterator &	operator=(const 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()

Constructor & Destructor Documentation

CPosLmItemIterator()

IMPORT_C

CPosLmItemIterator

(

)

[protected]

CPosLmItemIterator(const CPosLmItemIterator &)

CPosLmItemIterator

(

const CPosLmItemIterator &

)

[private]

Parameters

const CPosLmItemIterator &

~CPosLmItemIterator()

IMPORT_C

~CPosLmItemIterator

(

)

[virtual]

Destructor.

Member Functions Documentation

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

void	GetItemIdsL	(	RArray< TPosLmItemId > &	aIdArray,
			TInt	aStartIndex,
			TInt	aNumOfItems
		)	[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.

Parameters

RArray< TPosLmItemId > & aIdArray	On return contains the requested items.
TInt aStartIndex	The index of the first item to fetch.
TInt aNumOfItems	The 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.

NumOfItemsL()

TUint

NumOfItemsL

(

)

[pure virtual]

Returns the number of database items which are iterated.

Reset()

void

Reset

(

)

[pure virtual]

Resets the database item iterator.

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

operator=(const CPosLmItemIterator &)

CPosLmItemIterator &

operator=

(

const CPosLmItemIterator &

)

[private]

Parameters

const CPosLmItemIterator &