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

#include <RxProtocolReactor.h>

Inheritance diagram for OdRxProtocolReactorIterator:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxProtocolReactorIterator)
 
virtual OdRxClassreactorClass () const =0
 
virtual void start ()=0
 
virtual bool next ()=0
 
virtual bool done () const =0
 
virtual OdRxProtocolReactorobject () 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

This class implements Iterators for OdRxProtocolReactor objects in OdRxProtocolReactorList instances.

Remarks
Instances are returned by OdRxProtocolReactorList::newIterator().

Corresponding C++ library: TD_Root <group OdRx_Classes>

Definition at line 63 of file RxProtocolReactor.h.

Member Function Documentation

◆ done()

virtual bool OdRxProtocolReactorIterator::done ( ) const
pure virtual

Returns true if and only if the traversal by this Iterator object is complete.

◆ next()

virtual bool OdRxProtocolReactorIterator::next ( )
pure virtual

Sets this Iterator object to reference the Reactor object following the current Reactor object.

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

◆ object()

virtual OdRxProtocolReactor* OdRxProtocolReactorIterator::object ( ) const
pure virtual

Returns the Reactor object referenced by this Iterator object.

◆ ODRX_DECLARE_MEMBERS()

OdRxProtocolReactorIterator::ODRX_DECLARE_MEMBERS ( OdRxProtocolReactorIterator  )

◆ reactorClass()

virtual OdRxClass* OdRxProtocolReactorIterator::reactorClass ( ) const
pure virtual

Returns the reactor class type returned by this Iterator object.

◆ start()

virtual void OdRxProtocolReactorIterator::start ( )
pure virtual

Sets this Iterator object to reference the Reactor object that it would normally return first.

Remarks
Allows multiple traversals of the Iterator list.

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