CFx SDK Documentation  2023 SP0
Public Member Functions | Friends | List of all members
OdDbIndexUpdateDataIterator Class Reference

#include <DbIndex.h>

Public Member Functions

 OdDbIndexUpdateDataIterator (const OdDbIndexUpdateData *pIndexUpdateData)
 
void start ()
 
OdDbObjectId id () const
 
void next ()
 
bool done ()
 
void currentData (OdDbObjectId &currentId, OdUInt8 &flags, OdUInt32 &data) const
 

Friends

class OdDbIndexUpdateDataIteratorImpl
 

Detailed Description

This class iterates through OdDbIndexUpdateData instances.

See also
TD_Db

<group OdDb_Classes>

Definition at line 248 of file DbIndex.h.

Constructor & Destructor Documentation

◆ OdDbIndexUpdateDataIterator()

OdDbIndexUpdateDataIterator::OdDbIndexUpdateDataIterator ( const OdDbIndexUpdateData pIndexUpdateData)

Member Function Documentation

◆ currentData()

void OdDbIndexUpdateDataIterator::currentData ( OdDbObjectId currentId,
OdUInt8 flags,
OdUInt32 data 
) const

Returns the Object ID of the entity currently referenced by this Iterator object, and the flags and data associated with it.

Parameters
currentId[out] Receives the current Object ID.
flags[out] Receives the 8-bit flags.
data[out] Receives the 32-bit data

◆ done()

bool OdDbIndexUpdateDataIterator::done ( )

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

◆ id()

OdDbObjectId OdDbIndexUpdateDataIterator::id ( ) const

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

◆ next()

void OdDbIndexUpdateDataIterator::next ( )

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

◆ start()

void OdDbIndexUpdateDataIterator::start ( )

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

Remarks
Allows multiple traversals of the iterator list.

Friends And Related Function Documentation

◆ OdDbIndexUpdateDataIteratorImpl

friend class OdDbIndexUpdateDataIteratorImpl
friend

Definition at line 250 of file DbIndex.h.


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