IIterable Struct Reference

An iterable object can construct iterators and use them to iterate through items. More...

Inheritance diagram for IIterable:

Collaboration diagram for IIterable:

Detailed Description

An iterable object can construct iterators and use them to iterate through items.

Use this interface to get the start and end iterators. Use iterators to iterate through available items. Containers such as lists and dictionaries usually implement this interface.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	createStartIterator (IIterator **iterator)=0
	Creates and returns the object's start iterator. More...
virtual ErrCode INTERFACE_FUNC	createEndIterator (IIterator **iterator)=0
	Creates and returns the object's end iterator. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

createEndIterator()

virtual ErrCode INTERFACE_FUNC createEndIterator ( IIterator **  iterator )

pure virtual

Creates and returns the object's end iterator.

Parameters

[out]

iterator

The object's end iterator.

createStartIterator()

virtual ErrCode INTERFACE_FUNC createStartIterator ( IIterator **  iterator )

pure virtual

Creates and returns the object's start iterator.

Parameters

[out]

iterator

The object's start iterator.