#include <DbObjectContextCollection.h>
Inheritance diagram for OdDbObjectContextCollectionIterator:
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdDbObjectContextCollectionIterator) | |
| virtual OdResult | start ()=0 |
| virtual bool | next ()=0 |
| virtual bool | done () const =0 |
| virtual OdDbObjectContextPtr | getContext () 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 |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class implements Iterators for objects that have context items defined and stored in a context collection (using the OdDbObjectContextCollections class).
- Remarks
- If an application supports context collections, you must implement this class. You can get an Iterator using OdDbObjectContextCollection::newIterator().
<group OdDb_Classes>
Definition at line 167 of file DbObjectContextCollection.h.
Member Function Documentation
◆ done()
|
pure virtual |
Returns whether the Iterator is at the end of the collection.
\returns Returns true if the Iterator is at the end of the collection, or returns false if it is not.
◆ getContext()
|
pure virtual |
Returns a copy of the context located at the current position of the Iterator.
◆ next()
|
pure virtual |
Moves the Iterator to the next context of the collection.
\returns Returns true if successful, or returns false if the Iterator is at the end of the collection.
◆ ODRX_DECLARE_MEMBERS()
| OdDbObjectContextCollectionIterator::ODRX_DECLARE_MEMBERS | ( | OdDbObjectContextCollectionIterator | ) |
◆ start()
|
pure virtual |
Moves the Iterator to the start of the collection.
\returns Returns eOk if successful, or an appropriate error code if not.
The documentation for this class was generated from the following file: