OdDbSymbolTableIterator Class Reference

#include <DbSymbolTable.h>

Inheritance diagram for OdDbSymbolTableIterator:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbSymbolTableIterator)
virtual void	start (bool atBeginning=true, bool skipErased=true)
virtual bool	done () const
virtual OdDbObjectId	getRecordId () const
virtual OdDbSymbolTableRecordPtr	getRecord (OdDb::OpenMode openMode=OdDb::kForRead, bool openErasedRecord=false) const
virtual void	step (bool forward=true, bool skipErased=true)
virtual void	seek (const OdDbObjectId &ObjectId)
virtual void	seek (const OdDbSymbolTableRecord *pRecord)
virtual	~OdDbSymbolTableIterator ()
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

Protected Member Functions
	OdDbSymbolTableIterator ()
	OdDbSymbolTableIterator (OdDbSymbolTableIteratorImpl *pImpl)

Protected Attributes
OdDbSymbolTableIteratorImpl *	m_pImpl

Friends
class	OdDbSymbolTable

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class implements bidirectional Iterators for OdDbSymbolTable objects in an OdDbDatabase instance.

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 237 of file DbSymbolTable.h.

Constructor & Destructor Documentation

~OdDbSymbolTableIterator()

virtual OdDbSymbolTableIterator::~OdDbSymbolTableIterator ( )

virtual

OdDbSymbolTableIterator() [1/2]

OdDbSymbolTableIterator::OdDbSymbolTableIterator ( )

protected

OdDbSymbolTableIterator() [2/2]

OdDbSymbolTableIterator::OdDbSymbolTableIterator ( OdDbSymbolTableIteratorImpl *  pImpl )

protected

Member Function Documentation

done()

virtual bool OdDbSymbolTableIterator::done ( ) const

virtual

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

getRecord()

virtual OdDbSymbolTableRecordPtr OdDbSymbolTableIterator::getRecord ( OdDb::OpenMode  openMode = OdDb::kForRead, bool  openErasedRecord = false  ) const

virtual

Opens the record currently referenced by this Iterator object.

Parameters

openMode	[in] Mode in which to open the record.
openErasedRecord	[in] If and only if true, erased records will be opened.

Returns

Returns a SmartPointer to the opened record if successful, otherwise a null SmartPointer.

getRecordId()

virtual OdDbObjectId OdDbSymbolTableIterator::getRecordId ( ) const

virtual

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

ODRX_DECLARE_MEMBERS()

OdDbSymbolTableIterator::ODRX_DECLARE_MEMBERS

(

OdDbSymbolTableIterator

)

seek() [1/2]

virtual void OdDbSymbolTableIterator::seek ( const OdDbObjectId &  ObjectId )

virtual

Positions this Iterator object at the specified record.

Parameters

objectId

[in] Object ID of the record.

seek() [2/2]

virtual void OdDbSymbolTableIterator::seek ( const OdDbSymbolTableRecord *  pRecord )

virtual

Positions this Iterator object at the specified record.

Parameters

pRecord

[in] Pointer to the record.

start()

virtual void OdDbSymbolTableIterator::start ( bool  atBeginning = true, bool  skipErased = true  )

virtual

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

Remarks

Allows multiple traversals of the iterator list.

Parameters

atBeginning	[in] True to start at the beginning, false to start at the end.
skipErased	[in] If and only if true, erased records are skipped.

step()

virtual void OdDbSymbolTableIterator::step ( bool  forward = true, bool  skipErased = true  )

virtual

Steps this Iterator object.

Parameters

forward	[in] True to step forward, false to step backward.
skipErased	[in] If and only if true, erased records are skipped.

Friends And Related Function Documentation

OdDbSymbolTable

friend class OdDbSymbolTable

friend

Definition at line 304 of file DbSymbolTable.h.

Member Data Documentation

m_pImpl

OdDbSymbolTableIteratorImpl* OdDbSymbolTableIterator::m_pImpl

protected

Definition at line 310 of file DbSymbolTable.h.

---

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

• DbSymbolTable.h