CFx SDK Documentation  2020SP3
Public Member Functions | Friends | List of all members
OdDbBlockChangeIterator Class Reference

#include <DbIndex.h>

Public Member Functions

void start ()
 
OdDbObjectId id () const
 
void next ()
 
bool done ()
 
void curIdInfo (OdDbObjectId &currentId, OdUInt8 &flags, OdUInt32 &data) const
 
void setCurIdInfo (OdUInt8 flags, OdUInt32 data)
 
OdDbIndexUpdateDataupdateData () const
 
void clearProcessedFlags ()
 

Friends

class OdDbBlockChangeIteratorImpl
 

Detailed Description

This class iterates through changed entities in an OdDbBlockTableRecord instance.

See also
TD_Db

<group OdDb_Classes>

Definition at line 68 of file DbIndex.h.

Member Function Documentation

◆ clearProcessedFlags()

void OdDbBlockChangeIterator::clearProcessedFlags ( )

Clears the processed bit (0x04) of the flags of entities being traversed.

◆ curIdInfo()

void OdDbBlockChangeIterator::curIdInfo ( 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 OdDbBlockChangeIterator::done ( )

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

◆ id()

OdDbObjectId OdDbBlockChangeIterator::id ( ) const

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

◆ next()

void OdDbBlockChangeIterator::next ( )

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

◆ setCurIdInfo()

void OdDbBlockChangeIterator::setCurIdInfo ( OdUInt8  flags,
OdUInt32  data 
)

Sets the flags and data associated with the object currently referenced by this Iterator object.

Parameters
flags[in] Current object 8-bit flags.
data[in] Current object 32-bit data

◆ start()

void OdDbBlockChangeIterator::start ( )

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

Remarks
Allows multiple traversals of the iterator list.

◆ updateData()

OdDbIndexUpdateData* OdDbBlockChangeIterator::updateData ( ) const

Returns the OdDbIndexUpdateData object associating Object IDs to data and flags.

Friends And Related Function Documentation

◆ OdDbBlockChangeIteratorImpl

friend class OdDbBlockChangeIteratorImpl
friend

Definition at line 71 of file DbIndex.h.


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