OdDbDictionaryIterator Class Reference

#include <DbDictionary.h>

Inheritance diagram for OdDbDictionaryIterator:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbDictionaryIterator)
virtual	~OdDbDictionaryIterator ()
virtual OdString	name () const =0
virtual OdDbObjectPtr	getObject (OdDb::OpenMode openMode=OdDb::kForRead)=0
virtual OdDbObjectId	objectId () const =0
virtual bool	setPosition (OdDbObjectId objectId)=0
virtual OdRxObjectPtr	object () const
Public Member Functions inherited from OdRxIterator
	OdRxIterator ()
	ODRX_DECLARE_MEMBERS (OdRxIterator)
virtual bool	done () const =0
virtual bool	next ()=0
virtual OdRxObjectPtr	object () const =0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdDbDictionaryIterator ()

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class implements Iterator objects that traverse entries in OdDbDictionary objects in an OdDbDatabase instance.

Corresponding C++ library: TD_Db

Remarks

An OdDbDictionaryIterator maintains a "current position" within the entries of the associated dictionary, and can provide access to the key value and object at the current position.

<group OdDb_Classes>

Definition at line 53 of file DbDictionary.h.

Constructor & Destructor Documentation

~OdDbDictionaryIterator()

virtual OdDbDictionaryIterator::~OdDbDictionaryIterator ( )

inlinevirtual

Definition at line 58 of file DbDictionary.h.

OdDbDictionaryIterator()

OdDbDictionaryIterator::OdDbDictionaryIterator ( )

inlineprotected

Definition at line 105 of file DbDictionary.h.

Member Function Documentation

getObject()

virtual OdDbObjectPtr OdDbDictionaryIterator::getObject ( OdDb::OpenMode  openMode = OdDb::kForRead )

pure virtual

Opens the dictionary entry currently referenced by this Iterator object.

Parameters

mode	[in] Mode in which to open the object.

Returns

Returns a SmartPointer to the opened object.

name()

virtual OdString OdDbDictionaryIterator::name ( ) const

pure virtual

Returns the name (key) of the dictionary entry currently referenced by this Iterator object.

object()

virtual OdRxObjectPtr OdDbDictionaryIterator::object ( ) const

virtual

Opens the dictionary entry currently referenced by this Iterator object in OdDb::kForRead mode.

Returns

Returns a SmartPointer to the opened object.

Implements OdRxIterator.

objectId()

virtual OdDbObjectId OdDbDictionaryIterator::objectId ( ) const

pure virtual

Returns the Object ID of the dictionary entry currently referenced by this Iterator object.

ODRX_DECLARE_MEMBERS()

OdDbDictionaryIterator::ODRX_DECLARE_MEMBERS

(

OdDbDictionaryIterator

)

setPosition()

virtual bool OdDbDictionaryIterator::setPosition ( OdDbObjectId  objectId )

pure virtual

Sets the current position of this Iterator to the dictionary entry containing the specified ObjectId.

Parameters

objectId

[in] Object ID of item to which the current position will be set.

Returns

Returns true if and only if the current position was set to the specified item.

---

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

• DbDictionary.h