Iterable Class Reference

Abstract class which allow to iterate over object. More...

Inheritance diagram for Iterable:

Public Member Functions
bool	contains (const void *self, const void *object)
	Check if object is in the collection. More...
void	clear (void *self)
	Remove all items from iterable. More...
void *	next (const void *self, const void *iterator)
Public Member Functions inherited from Object
void *	ref (void *self)
	Increment object's reference counter. More...
void	unref (void *self)
	Decrement object's reference counter, if equals 0, delete the object. More...
bool	equal (const void *self, const void *other)
	Check objects equality. More...

Detailed Description

Abstract class which allow to iterate over object.

Exceptions

AbstractError

MUST be subclassed.

Member Function Documentation

void clear

(

void *

self

)

Remove all items from iterable.

Parameters

self	Iterable object.

MUST be implemented in a subclass.

bool contains	(	const void *	self,
		const void *	object
	)

Check if object is in the collection.

Parameters

object	Object instance (will be unreferenced).void *self, const void *object)
self	Iterable object.
object	Object instance.

Returns

TRUE if object is in collection, FALSE otherwise.

MUST be implemented in a subclass.

void * next	(	const void *	self,
		const void *	iterator
	)

Parameters

self	Iterable object.
iterator	Iterator object pointing to current item.

Returns

Next item.

Exceptions

NotImplementedError

MUST be implemented in a subclass.