OdDbIndexUpdateData Class Reference

#include <DbIndex.h>

Public Types
enum	UpdateFlags { kModified = 1 , kDeleted = 2 , kProcessed = 4 , kUnknownKey = 8 }

Public Member Functions
OdDbObjectId	objectBeingIndexedId () const
void	addId (OdDbObjectId objectId)
bool	setIdFlags (OdDbObjectId objectId, OdUInt8 flags)
bool	setIdData (OdDbObjectId objectId, OdUInt32 data)
bool	getIdData (OdDbObjectId objectId, OdUInt32 &data) const
bool	getIdFlags (OdDbObjectId objectId, OdUInt8 &flags) const
bool	getFlagsAndData (OdDbObjectId objectId, OdUInt8 &flags, OdUInt32 &data) const

Friends
class	OdDbIndexUpdateDataImpl

Detailed Description

This class associates Index specific flags and data with an OdDbObjectId.

<group OdDb_Classes>

Definition at line 137 of file DbIndex.h.

Member Enumeration Documentation

UpdateFlags

enum OdDbIndexUpdateData::UpdateFlags

Enumerator
kModified
kDeleted
kProcessed
kUnknownKey

Definition at line 145 of file DbIndex.h.

Member Function Documentation

addId()

void OdDbIndexUpdateData::addId

(

OdDbObjectId

objectId

)

Adds the specified Object ID to this OdDbIndexUpdateData object.

Parameters

Object

ID [in] Object ID to be added.

getFlagsAndData()

bool OdDbIndexUpdateData::getFlagsAndData	(	OdDbObjectId	objectId,
		OdUInt8 &	flags,
		OdUInt32 &	data
	)		const

Returns the flags and data associated with the specified Object ID in this OdDbIndexUpdateData object.

Parameters

objectID	[in] Object ID.
flags	[out] Receives the 8-bit flags.
data	[out] Receives the 32-bit data.

Remarks

Returns true if and only if successful.

getIdData()

bool OdDbIndexUpdateData::getIdData	(	OdDbObjectId	objectId,
		OdUInt32 &	data
	)		const

Returns the data associated with the specified Object ID in this OdDbIndexUpdateData object.

Parameters

objectID	[in] Object ID.
data	[out] 32-bit data.

Remarks

Returns true if and only if successful.

getIdFlags()

bool OdDbIndexUpdateData::getIdFlags	(	OdDbObjectId	objectId,
		OdUInt8 &	flags
	)		const

Returns the flags associated with the specified Object ID in this OdDbIndexUpdateData object.

Parameters

objectID	[in] Object ID.
flags	[out] Receives the 8-bit flags.

Remarks

Returns true if and only if successful.

objectBeingIndexedId()

OdDbObjectId OdDbIndexUpdateData::objectBeingIndexedId

(

)

const

Returns the Object ID of the OdDbBlockTableRecord instance that owns this OdDbIndexUpdateData object.

setIdData()

bool OdDbIndexUpdateData::setIdData	(	OdDbObjectId	objectId,
		OdUInt32	data
	)

Sets the data associated with the specified Object ID in this OdDbIndexUpdateData object.

Parameters

objectID	[in] Object ID.
data	[in] 32-bit data.

Remarks

Returns true if and only if successful.

setIdFlags()

bool OdDbIndexUpdateData::setIdFlags	(	OdDbObjectId	objectId,
		OdUInt8	flags
	)

Sets the flags associated with the specified Object ID in this OdDbIndexUpdateData object.

Parameters

objectID	[in] Object ID.
flags	[in] 8-bit flags.

Remarks

Returns true if and only if successful.

Friends And Related Function Documentation

OdDbIndexUpdateDataImpl

friend class OdDbIndexUpdateDataImpl

friend

Definition at line 139 of file DbIndex.h.

---

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

• DbIndex.h