CFx SDK Documentation  2022 SP0
Public Member Functions | Static Public Member Functions | List of all members
OdRxDispatchImpl< TBase >::Iterator Class Reference

#include <RxDispatchImpl.h>

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

Public Member Functions

 Iterator (OdRxDictionary *pOwner, OdRxDictionaryIterator *pDescIter)
 
OdString getKey () const
 
OdUInt32 id () const
 
bool done () const
 
bool next ()
 
OdRxObjectPtr object () const
 
- Public Member Functions inherited from OdRxObjectImpl< OdRxDictionaryIterator >
 OdRxObjectImpl ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
- Public Member Functions inherited from OdRxDictionaryIterator
 ODRX_DECLARE_MEMBERS (OdRxDictionaryIterator)
 
- Public Member Functions inherited from OdRxIterator
 OdRxIterator ()
 
 ODRX_DECLARE_MEMBERS (OdRxIterator)
 
- 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
 
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
 

Static Public Member Functions

static OdRxDictionaryIteratorPtr createObject (OdRxDictionary *pOwner, OdRxDictionaryIterator *pDescIter)
 
- Static Public Member Functions inherited from OdRxObjectImpl< OdRxDictionaryIterator >
static OdSmartPtr< OdRxDictionaryIteratorcreateObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Additional Inherited Members

- Protected Member Functions inherited from OdRxObjectImpl< OdRxDictionaryIterator >
 ODRX_HEAP_OPERATORS ()
 

Detailed Description

template<class TBase = OdRxDictionary>
class OdRxDispatchImpl< TBase >::Iterator

Definition at line 61 of file RxDispatchImpl.h.

Constructor & Destructor Documentation

◆ Iterator()

template<class TBase = OdRxDictionary>
OdRxDispatchImpl< TBase >::Iterator::Iterator ( OdRxDictionary pOwner,
OdRxDictionaryIterator pDescIter 
)
inline

Definition at line 66 of file RxDispatchImpl.h.

Member Function Documentation

◆ createObject()

template<class TBase = OdRxDictionary>
static OdRxDictionaryIteratorPtr OdRxDispatchImpl< TBase >::Iterator::createObject ( OdRxDictionary pOwner,
OdRxDictionaryIterator pDescIter 
)
inlinestatic

Definition at line 69 of file RxDispatchImpl.h.

◆ done()

template<class TBase = OdRxDictionary>
bool OdRxDispatchImpl< TBase >::Iterator::done ( ) const
inlinevirtual

Returns true if and only if the traversal by this iterator object is completed.

Implements OdRxIterator.

Definition at line 75 of file RxDispatchImpl.h.

◆ getKey()

template<class TBase = OdRxDictionary>
OdString OdRxDispatchImpl< TBase >::Iterator::getKey ( ) const
inlinevirtual

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>

Implements OdRxDictionaryIterator.

Definition at line 73 of file RxDispatchImpl.h.

◆ id()

template<class TBase = OdRxDictionary>
OdUInt32 OdRxDispatchImpl< TBase >::Iterator::id ( ) const
inlinevirtual

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>

Implements OdRxDictionaryIterator.

Definition at line 74 of file RxDispatchImpl.h.

◆ next()

template<class TBase = OdRxDictionary>
bool OdRxDispatchImpl< TBase >::Iterator::next ( )
inlinevirtual

Sets the iterator object to the next element of the container.

Remarks
Returns true if and only if not at the end of the list.

Implements OdRxIterator.

Definition at line 76 of file RxDispatchImpl.h.

◆ object()

template<class TBase = OdRxDictionary>
OdRxObjectPtr OdRxDispatchImpl< TBase >::Iterator::object ( ) const
inlinevirtual

Returns the non-typified smart pointer to the object on which the iterator object refers.

Implements OdRxIterator.

Definition at line 77 of file RxDispatchImpl.h.


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