zeus::IXObjectCollection Class Reference

#include <IXObjectCollection.hpp>

Inheritance diagram for zeus::IXObjectCollection:

List of all members.

Public Member Functions
virtual Int MQUALIFIER	getCount () const =0
virtual Retval MQUALIFIER	getObject (Int iIndex, IXObject *&rpObject) const =0
virtual Retval MQUALIFIER	getCastedObject (Int iIndex, const InterfaceID &rInterfaceID, IZUnknown *&rpObject) const =0
virtual Retval MQUALIFIER	getNextObject (IXObject *&rpObject) const =0
virtual Retval MQUALIFIER	getNextCastedObject (const InterfaceID &rInterfaceID, IZUnknown *&rpObject) const =0
virtual Int MQUALIFIER	getIndex (const IXObject &rXObject) const =0
virtual void MQUALIFIER	reset () const =0

---

Detailed Description

This interface defines a collection of XObjects. This may be used as a query result of getting objects out of a tree.

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::IXObjectCollection::getCastedObject	(	Int	iIndex,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)		const [pure virtual]

This method returns an indexed object out of the collection. The object will be casted with the corresponding interface ID.

Parameters:

iIndex,:	Index of the requested object
rInterfaceID,:	ID of the interface
rpObject,:	Return parameter

Return values:

RET_NOERROR,:	Object returned
RET_REQUEST_FAILED,:	Could not find object

Implemented in zeus::TXObjectCollection.

virtual Int MQUALIFIER zeus::IXObjectCollection::getCount

(

)

const [pure virtual]

This returns the number of objects inside this collection

Returns:

number of objects

Implemented in zeus::TXObjectCollection.

virtual Int MQUALIFIER zeus::IXObjectCollection::getIndex

(

const IXObject &

rXObject )

const [pure virtual]

Get the index of a given X object in this collection.

Parameters:

rXObject,:

The given X object.

Return values:

>=	0: Index in this collection.
-1,:	rXObject is no member of this collection.

Implemented in zeus::TXObjectCollection.

virtual Retval MQUALIFIER zeus::IXObjectCollection::getNextCastedObject	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)		const [pure virtual]

This gets the next object using an internal iterator of the collection. The object will be casted with the corresponding interface ID. If the cast fails, automatically the next matching object will be returned.

Parameters:

rInterfaceID,:	ID of the interface
rpObject,:	Return parameter

Return values:

RET_NOERROR,:	Object returned
RET_REQUEST_FAILED,:	Could not find next object

Implemented in zeus::TXObjectCollection.

virtual Retval MQUALIFIER zeus::IXObjectCollection::getNextObject

(

IXObject *&

rpObject )

const [pure virtual]

This gets the next object using an internal iterator of the collection.

Parameters:

rpObject,:

Return parameter

Return values:

RET_NOERROR,:	Object returned
RET_REQUEST_FAILED,:	Could not find next object

Implemented in zeus::TXObjectCollection.

virtual Retval MQUALIFIER zeus::IXObjectCollection::getObject	(	Int	iIndex,
		IXObject *&	rpObject
	)		const [pure virtual]

This method returns an indexed object out of the collection

Parameters:

iIndex,:	Index of the object
rpObject,:	Return parameter

Return values:

RET_NOERROR,:	Object returned
RET_REQUEST_FAILED,:	Could not find indexed object

Implemented in zeus::TXObjectCollection.

virtual void MQUALIFIER zeus::IXObjectCollection::reset

(

)

const [pure virtual]

Resets the internal iterator

Implemented in zeus::TXObjectCollection.

---

The documentation for this class was generated from the following file:

• IXObjectCollection.hpp