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

#include <DbGroup.h>

Inheritance diagram for OdDbGroupIterator:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbGroupIterator)
 
virtual OdDbObjectPtr getObject (OdDb::OpenMode openMode)=0
 
virtual OdDbObjectId objectId () const =0
 
virtual bool done () const =0
 
virtual bool next ()=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
 

Protected Member Functions

 OdDbGroupIterator ()
 

Additional Inherited Members

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

Detailed Description

This class defines Iterator objects that traverse entries in OdDbGroup objects in an OdDbDatabase instance.

See also
TD_Db

<group OdDb_Classes>

Definition at line 48 of file DbGroup.h.

Constructor & Destructor Documentation

◆ OdDbGroupIterator()

OdDbGroupIterator::OdDbGroupIterator ( )
inlineprotected

Definition at line 86 of file DbGroup.h.

Member Function Documentation

◆ done()

virtual bool OdDbGroupIterator::done ( ) const
pure virtual

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

◆ getObject()

virtual OdDbObjectPtr OdDbGroupIterator::getObject ( OdDb::OpenMode  openMode)
pure virtual

Returns the entity currently referenced by this Iterator object.

Parameters
openMode[in] Mode in which to open the current entity.
Remarks
Returns a null SmartPointer if not successful.

◆ next()

virtual bool OdDbGroupIterator::next ( )
pure virtual

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

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

◆ objectId()

virtual OdDbObjectId OdDbGroupIterator::objectId ( ) const
pure virtual

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

◆ ODRX_DECLARE_MEMBERS()

OdDbGroupIterator::ODRX_DECLARE_MEMBERS ( OdDbGroupIterator  )

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