CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdRxDictionaryIterator Class Referenceabstract

#include <RxDictionary.h>

Inheritance diagram for OdRxDictionaryIterator:
OdRxIterator OdRxObject OdRxObjectImpl< OdRxDictionaryIterator > OdRxDispatchImpl< TBase >::Iterator

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxDictionaryIterator)
 
virtual OdString getKey () const =0
 
virtual OdUInt32 id () const =0
 
- 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdRx_Classes>

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

Corresponding C++ library: TD_Db

Remarks
An OdRxDictionaryIterator 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.
See also
<link dictionary_sample.html, Example of Working with a Dictionary>
<link iterator_overview.html, Overview of Classes that Implement an Iterator>

<link dictionary_iterating.html, Iterating through Items of a Dictionary>

Definition at line 60 of file RxDictionary.h.

Member Function Documentation

◆ getKey()

virtual OdString OdRxDictionaryIterator::getKey ( ) const
pure virtual

Returns the keyword associated with the item of the dictionary on which the iterator refers

See also
<link dictionary_sample.html, Example of Working with a Dictionary>

Implemented in OdRxDispatchImpl< TBase >::Iterator.

◆ id()

virtual OdUInt32 OdRxDictionaryIterator::id ( ) const
pure virtual

Returns the ID of the item in the dictionary on which the iterator refers

See also
<link dictionary_sample.html, Example of Working with a Dictionary>

Implemented in OdRxDispatchImpl< TBase >::Iterator.

◆ ODRX_DECLARE_MEMBERS()

OdRxDictionaryIterator::ODRX_DECLARE_MEMBERS ( OdRxDictionaryIterator  )

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