OdDbTableIterator Class Reference

#include <DbTableIterator.h>

Inheritance diagram for OdDbTableIterator:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbTableIterator)
	OdDbTableIterator (const OdDbTable *pTable)
	OdDbTableIterator (const OdDbTable *pTable, const OdCellRange &range, OdDb::TableIteratorOption nOption)
	OdDbTableIterator (const OdDbLinkedTableData *pTable)
	OdDbTableIterator (const OdDbLinkedTableData *pTable, const OdCellRange &range, OdDb::TableIteratorOption nOption)
	OdDbTableIterator (const OdCellRange &range)
	OdDbTableIterator (const OdCellRange &range, OdDb::TableIteratorOption nOption)
	~OdDbTableIterator ()
void	start (void)
void	step (void)
bool	done (void)
bool	seek (const OdDbCell &cell)
OdDbCell	getCell (void) const
OdInt32	getRow (void) const
OdInt32	getColumn (void) const
Public Member Functions inherited from OdStaticRxObject< OdRxObject >
void	addRef ()
void	release ()
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 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 OdSmartPtr< OdDbTableIterator >	createObject (const OdDbTable *pTable)
static OdSmartPtr< OdDbTableIterator >	createObject (const OdDbTable *pTable, const OdCellRange &range, OdDb::TableIteratorOption nOption)
static OdSmartPtr< OdDbTableIterator >	createObject (const OdDbLinkedTableData *pTable)
static OdSmartPtr< OdDbTableIterator >	createObject (const OdDbLinkedTableData *pTable, const OdCellRange &range, OdDb::TableIteratorOption nOption)
static OdSmartPtr< OdDbTableIterator >	createObject (const OdCellRange &range)
static OdSmartPtr< OdDbTableIterator >	createObject (const OdCellRange &range, OdDb::TableIteratorOption nOption)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
	OdDbTableIterator (void)
	OdDbTableIterator (OdDbTableIteratorImpl *pImpl)

Protected Attributes
OdDbTableIteratorImpl *	m_pImpl

Detailed Description

This class implements Iterator objects that traverse columns, rows and cells of tables.

Remarks

Instances of this class are returned by OdDbTable::getIterator() or OdDbLinkedTableData::getIterator() methods.

<group OdDb_Classes>

Definition at line 55 of file DbTableIterator.h.

Constructor & Destructor Documentation

OdDbTableIterator() [1/8]

OdDbTableIterator::OdDbTableIterator

(

const OdDbTable *

pTable

)

OdDbTableIterator() [2/8]

OdDbTableIterator::OdDbTableIterator	(	const OdDbTable *	pTable,
		const OdCellRange &	range,
		OdDb::TableIteratorOption	nOption
	)

OdDbTableIterator() [3/8]

OdDbTableIterator::OdDbTableIterator

(

const OdDbLinkedTableData *

pTable

)

OdDbTableIterator() [4/8]

OdDbTableIterator::OdDbTableIterator	(	const OdDbLinkedTableData *	pTable,
		const OdCellRange &	range,
		OdDb::TableIteratorOption	nOption
	)

OdDbTableIterator() [5/8]

OdDbTableIterator::OdDbTableIterator

(

const OdCellRange &

range

)

OdDbTableIterator() [6/8]

OdDbTableIterator::OdDbTableIterator	(	const OdCellRange &	range,
		OdDb::TableIteratorOption	nOption
	)

~OdDbTableIterator()

OdDbTableIterator::~OdDbTableIterator

(

)

OdDbTableIterator() [7/8]

OdDbTableIterator::OdDbTableIterator ( void  )

protected

OdDbTableIterator() [8/8]

OdDbTableIterator::OdDbTableIterator ( OdDbTableIteratorImpl *  pImpl )

protected

Member Function Documentation

createObject() [1/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdCellRange &  range )

static

createObject() [2/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdCellRange &  range, OdDb::TableIteratorOption  nOption  )

static

createObject() [3/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdDbLinkedTableData *  pTable )

static

createObject() [4/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdDbLinkedTableData *  pTable, const OdCellRange &  range, OdDb::TableIteratorOption  nOption  )

static

createObject() [5/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdDbTable *  pTable )

static

createObject() [6/6]

static OdSmartPtr<OdDbTableIterator> OdDbTableIterator::createObject ( const OdDbTable *  pTable, const OdCellRange &  range, OdDb::TableIteratorOption  nOption  )

static

done()

bool OdDbTableIterator::done

(

void

)

Returns a value indicating whether this Iterator object has reached the end of the iterated range.

Returns

True if the end of the iterating range is reached, false otherwise.

getCell()

OdDbCell OdDbTableIterator::getCell

(

void

)

const

Returns the cell this Iterator object currently refers to.

Returns

The object of the OdDbCell class.

getColumn()

OdInt32 OdDbTableIterator::getColumn

(

void

)

const

Returns the index of the column of the current iteration position.

Returns

The index of the column within the iteration range. Returns -1 if rows are currently iterated.

getRow()

OdInt32 OdDbTableIterator::getRow

(

void

)

const

Returns the index of the row of the current iteration position.

Returns

The index of the row within the iteration range. Returns -1 if columns are currently iterated.

ODRX_DECLARE_MEMBERS()

OdDbTableIterator::ODRX_DECLARE_MEMBERS

(

OdDbTableIterator

)

seek()

bool OdDbTableIterator::seek

(

const OdDbCell &

cell

)

Positions this Iterator object at the specified cell.

Parameters

cell	[in] The cell to set the Iterator object at.

Returns

True if the specified cell is found within the iterating range, false otherwise.

Remarks

If the specified cell is not found within the iterating range, the Iterator object remains unchanged.

start()

void OdDbTableIterator::start

(

void

)

Sets this Iterator object to the beginning of the iterated range.

step()

void OdDbTableIterator::step

(

void

)

Increments this Iterator object so that it refers to the next object of the iterated range.

Member Data Documentation

m_pImpl

OdDbTableIteratorImpl* OdDbTableIterator::m_pImpl

protected

Definition at line 128 of file DbTableIterator.h.

---

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

• DbTableIterator.h