OdDbBlockIterator Class Reference

#include <DbBlockIterator.h>

Inheritance diagram for OdDbBlockIterator:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbBlockIterator)
virtual void	start ()=0
virtual OdDbObjectId	next ()=0
virtual OdDbObjectId	id () const =0
virtual bool	seek (OdDbObjectId objectId)=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

Static Public Member Functions
static OdDbBlockIteratorPtr	newBlockIterator (const OdDbBlockTableRecord *pBtr)
static OdDbBlockIteratorPtr	newFilteredIterator (const OdDbBlockTableRecord *pBtr, const OdDbFilter *pFilter)
static OdDbBlockIteratorPtr	newCompositeIterator (const OdDbBlockTableRecord *pBtr, const OdArray< OdSmartPtr< OdDbFilter > > &filters)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
	OdDbBlockIterator ()

Detailed Description

This class implements Iterator objects that traverse entries in OdDbBlockTableRecord objects in an OdDbDatabase instance.

Remarks

Instances are returned by OdDbBlockTableRecord::newIterator().

<group OdDb_Classes>

Definition at line 53 of file DbBlockIterator.h.

Constructor & Destructor Documentation

OdDbBlockIterator()

OdDbBlockIterator::OdDbBlockIterator ( )

inlineprotected

Definition at line 56 of file DbBlockIterator.h.

Member Function Documentation

id()

virtual OdDbObjectId OdDbBlockIterator::id ( ) const

pure virtual

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

newBlockIterator()

static OdDbBlockIteratorPtr OdDbBlockIterator::newBlockIterator ( const OdDbBlockTableRecord *  pBtr )

static

Returns an Iterator object that can be used to traverse the specified Block Table Record.

Parameters

pBtr	[in] Pointer the Block Table Record to traverse.

newCompositeIterator()

static OdDbBlockIteratorPtr OdDbBlockIterator::newCompositeIterator ( const OdDbBlockTableRecord *  pBtr, const OdArray< OdSmartPtr< OdDbFilter > > &  filters  )

static

Returns an Iterator object that can be used to traverse queries defined by an array of OdDbFilter objects applied to the specified Block Table Record.

Parameters

pBtr	[in] Pointer the Block Table Record to traverse.
filters	[in] Array of pointers to filter objects.

newFilteredIterator()

static OdDbBlockIteratorPtr OdDbBlockIterator::newFilteredIterator ( const OdDbBlockTableRecord *  pBtr, const OdDbFilter *  pFilter  )

static

Returns an Iterator object that can be used to traverse queries defined by OdDbFilter objects applied to the specified Block Table Record.

Parameters

pBtr	[in] Pointer the Block Table Record to traverse.
pFilter	[in] Pointer to the filter.

next()

virtual OdDbObjectId OdDbBlockIterator::next ( )

pure virtual

Returns the Object ID of the next object, and increments this Iterator object.

ODRX_DECLARE_MEMBERS()

OdDbBlockIterator::ODRX_DECLARE_MEMBERS

(

OdDbBlockIterator

)

seek()

virtual bool OdDbBlockIterator::seek ( OdDbObjectId  objectId )

pure virtual

Positions this Iterator object at the specified record.

Parameters

objectId

[in] Object ID of the record.

Returns

Returns true if and only if successful.

start()

virtual void OdDbBlockIterator::start ( )

pure virtual

Sets this Iterator object to reference the OdDbBlock 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:

• DbBlockIterator.h