#include <DbIndex.h>

Inheritance diagram for OdDbIndex:

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbIndex)

	OdDbIndex ()

virtual OdDbFilteredBlockIteratorPtr	newIterator (const OdDbFilter *pFilter) const

virtual void	rebuildFull (OdDbIndexUpdateData *pIdxData)

void	setLastUpdatedAt (const OdDbDate &time)

OdDbDate	lastUpdatedAt () const

void	setLastUpdatedAtU (const OdDbDate &time)

OdDbDate	lastUpdatedAtU () const

bool	isUptoDate () const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

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

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
virtual void	rebuildModified (OdDbBlockChangeIterator *iterator)

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Friends
class	OdDbIndexImpl

void	processBTRIndexObjects (OdDbBlockTableRecord pBTR, int indexCtlVal, OdDbBlockChangeIterator pBlkChgIter, OdDbIndexUpdateData *pIdxUpdData)

Additional Inherited Members
Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0, kDrawableIsAnEntity = 1, kDrawableUsesNesting = 2, kDrawableIsCompoundObject = 4, kDrawableViewIndependentViewportDraw = 8, kDrawableIsInvisible = 16, kDrawableHasAttributes = 32, kDrawableRegenTypeDependantGeometry = 64, kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), kDrawableRegenDraw = 256, kDrawableStandardDisplaySingleLOD = 512, kDrawableShadedDisplaySingleLOD = 1024, kDrawableViewDependentViewportDraw = 2048, kDrawableBlockDependentViewportDraw = 4096, kDrawableIsExternalReference = 8192, kDrawableNotPlottable = 16384, kLastFlag = kDrawableNotPlottable }

enum	DrawableType { kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3, kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground, kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground, kImageBasedLightingBackground }

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

The class is the base class for all OdDb Index objects.

See also: TD_Db

Definition at line 302 of file DbIndex.h.

Constructor & Destructor Documentation

◆ OdDbIndex()

OdDbIndex::OdDbIndex ( )

Member Function Documentation

◆ dwgInFields()

virtual OdResult OdDbIndex::dwgInFields ( OdDbDwgFiler * pFiler )

virtual

Reads the .dwg file data of this object.

Parameters

pFiler [in] Filer object from which data are read.

Returns: Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ dwgOutFields()

virtual void OdDbIndex::dwgOutFields ( OdDbDwgFiler * pFiler ) const

virtual

Writes the .dwg file data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are written.

Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ dxfInFields()

virtual OdResult OdDbIndex::dxfInFields ( OdDbDxfFiler * pFiler )

virtual

Reads the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer from which data are read.

Returns: Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ dxfOutFields()

virtual void OdDbIndex::dxfOutFields ( OdDbDxfFiler * pFiler ) const

virtual

Writes the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are to be written.

Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ isUptoDate()

bool OdDbIndex::isUptoDate ( ) const

Returns true if and only if this Index object is up to date.

◆ lastUpdatedAt()

OdDbDate OdDbIndex::lastUpdatedAt ( ) const

Returns the Julian lastUpdatedAt timestamp for this Index object.

◆ lastUpdatedAtU()

OdDbDate OdDbIndex::lastUpdatedAtU ( ) const

Returns the UT lastUpdatedAt timestamp for this Index object.

◆ newIterator()

virtual OdDbFilteredBlockIteratorPtr OdDbIndex::newIterator ( const OdDbFilter * pFilter ) const

virtual

Creates an Iterator object that provides access to the entities in this Index object.

Parameters

pFilter [in] Pointer to the filter to be applied to this Index object.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ ODDB_DECLARE_MEMBERS()

OdDbIndex::ODDB_DECLARE_MEMBERS ( OdDbIndex )

◆ rebuildFull()

virtual void OdDbIndex::rebuildFull ( OdDbIndexUpdateData * pIdxData )

virtual

Fully rebuilds this Index object from the entities in the block table record object.

Parameters

pIdxData [in] Pointer to the OdDbIndexUpdateData object to be used in the rebuild.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ rebuildModified()

virtual void OdDbIndex::rebuildModified ( OdDbBlockChangeIterator * iterator )

protectedvirtual

Called by OdDbIndexFilterManager::updateIndexes() when only modifications are being registered.

Parameters

iterator [in] Iterator of modified entities.

Remarks: Modified entities includes added, deleted, and changed entities.; This class must be implemented in custom classes derived from OdDbIndex. A full rebuild may be performed if desired.

Reimplemented in OdDbSpatialIndex, and OdDbLayerIndex.

◆ setLastUpdatedAt()

void OdDbIndex::setLastUpdatedAt ( const OdDbDate & time )

Sets the Julian lastUpdatedAt timestamp for this Index object.

Parameters

time	[in] Julian date.

◆ setLastUpdatedAtU()

void OdDbIndex::setLastUpdatedAtU ( const OdDbDate & time )

Sets the UT lastUpdatedAt timestamp for this Index object.

Parameters

time	[in] UT date.

Friends And Related Function Documentation

◆ OdDbIndexImpl

friend class OdDbIndexImpl

friend

Definition at line 384 of file DbIndex.h.

◆ processBTRIndexObjects

void processBTRIndexObjects	(	OdDbBlockTableRecord *	pBTR,
		int	indexCtlVal,
		OdDbBlockChangeIterator *	pBlkChgIter,
		OdDbIndexUpdateData *	pIdxUpdData
	)

friend

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

DbIndex.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdDbIndex()

Member Function Documentation

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ isUptoDate()

◆ lastUpdatedAt()

◆ lastUpdatedAtU()

◆ newIterator()

◆ ODDB_DECLARE_MEMBERS()

◆ rebuildFull()

◆ rebuildModified()

◆ setLastUpdatedAt()

◆ setLastUpdatedAtU()

Friends And Related Function Documentation

◆ OdDbIndexImpl

◆ processBTRIndexObjects