Share

AcDbIndexFilterManager

Description

AcDbIndexFilterManager is a namespace that provides a collection of functions for index and filter access and maintenance functionality.

Notes

When using AutoCAD indexes, the INDEXCTL system variable must be set to the appropriate value. See the System Variables section of the AutoCAD Command Reference for information on INDEXCTL.

Functions

Function Description
addFilter This function adds a filter to the provided block reference. It replaces the AcDbFilter of the same AcRxClass if such a filter exists.Returns Acad::eOk if successful.
addIndex This function adds pIndex to the block. It will replace the one with the same AcRxClass if such an index exists. After the index is added, it is kept up-to-date through the AcIndexFilterManager::updateIndexes() calls. Returns Acad::eOk if successful.
getFilter This function is used to get at an AcDbFilter in a block reference. Returns Acad::eOk if successful or Acad::eKeyNotFound if the AcDbFilter does not exist.
getFilter This function is used to get at an AcDbFilter in a block reference. This function is usually called in conjunction with the numFilters function that gives the total number of filter objects in a block reference.Returns Acad::eOk if successful or Acad::eKeyNotFound if the index does not exist.
getIndex This function is used to get at an AcDbIndex in a Block Table Record. Returns Acad::eOk if successful or Acad::eKeyNotFound if the index does not exist.
getIndex This function is used to get at an AcDbIndex in a Block Table Record. This function is usually called in conjunction with the numIndexes function that gives the total number of indexes in a block table record.Returns Acad::eOk if successful or Acad::eKeyNotFound if the index does not exist.
numFilters This function returns the number of filters within the provided block reference. It returns 0 if no filters exist within the block reference.
numIndexes This function returns the number of indexes within the provided block table record. It returns 0 if no indexes exist within the block table record.
removeFilter This function removes a filter from the provided block.Returns Acad::eOk if successful or Acad::eKeyNotFound if the index does not exist.
removeIndex This function, if successful, removes the index object with the specified AcRxClass. Returns Acad::eOk if successful or Acad::eKeyNotFound if the index does not exist.
updateIndexes This function will update all the index objects associated with all the AcDbBlockTableRecords of the AcDbDatabase to reflect the contents of the block space. Updates are done by invoking the rebuildFull() or rebuildModified() methods of the AcDbIndex objects.

Was this information helpful?