#include <DbBlockTable.h>
Public Member Functions inherited from Detailed Description
This class implements the BlockTable, which represents block definitions in an OdDbDatabase instance.
- See also
- TD_Db
<group OdDb_Classes>
Definition at line 71 of file DbBlockTable.h.
Constructor & Destructor Documentation
◆ OdDbBlockTable()
| OdDbBlockTable::OdDbBlockTable | ( | ) |
Teigha applications typically will not use this constructor, insofar as the OdDbDatabase class creates its own instance.
Member Function Documentation
◆ add()
|
virtual |
Adds the specified named record object to the predefined table object.
- Parameters
-
pRecord [in] Pointer to the existing named record object to be added.
- Returns
- Returns the Object ID of the added record object.
- Remarks
- The record object must be created and must be named before adding. Use the static pseudo-constructor createObject() for creating an instance of the specific record. The predefined table object excludes duplicates of records.
Reimplemented from OdDbSymbolTable.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pFiler [in] A pointer to the undo filer with the partial undo information. pClass [in] A pointer to the OdRxClass object for the class that will handle the Undo.
- Remarks
- An object indicates it's using the partial undo mechanism, if and only if it has set autoUndo false in all calls to assertWriteEnabled(). This member function must know which types of fields to scan, and must stop after reading what it needs. If the class type specified by pClassObj does not matches the class of this object, this member function must call the parent class's applyPartialUndo() and return whatever it returns. If it does match the class of this object, this member function must use pUndoFiler to read the undo data, then typically use this object's set() method.
Reimplemented from OdDbObject.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Remarks
- 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 OdDbSymbolTable.
◆ dwgOutFields()
|
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 OdDbSymbolTable.
◆ dxfIn()
|
virtual |
Reads the DXF format data of this object from the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Remarks
- Returns the filer status. This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented from OdDbSymbolTable.
◆ getAt() [1/2]
|
virtual |
Searches the named record object in the predefined table object using the specified name and opens it in the specified mode.
- Parameters
-
recordName [in] Record name. openMode [in] Mode in which to open the record. getErasedRecord [in] If and only if true, erased records will be opened or retrieved.
- Returns
- A smart pointer to the object if successful, otherwise a null smart pointer
Reimplemented from OdDbSymbolTable.
◆ getAt() [2/2]
|
virtual |
Searches the named record object in the predefined table object using the specified name and opens it in the specified mode.
- Parameters
-
recordName [in] Record name. openMode [in] Mode in which to open the record. getErasedRecord [in] If and only if true, erased records will be opened or retrieved.
- Returns
- A smart pointer to the object if successful, otherwise a null smart pointer
Reimplemented from OdDbSymbolTable.
◆ getModelSpaceId()
| const OdDbObjectId& OdDbBlockTable::getModelSpaceId | ( | ) | const |
Returns the Object ID of the Model Space record within this BlockTable object.
◆ getPaperSpaceId()
| const OdDbObjectId& OdDbBlockTable::getPaperSpaceId | ( | ) | const |
Returns the Object ID of the Paper Space record within this BlockTable object.
◆ has() [1/2]
|
virtual |
Determines whether the named record object exists in the predefined table object using the specified object ID.
- Parameters
-
objectId [in] Object ID.
- Returns
- Returns true if and only if the predefined table object contains the specified record object.
Reimplemented from OdDbSymbolTable.
◆ has() [2/2]
|
virtual |
Determines whether the named record object exists in the predefined table object using the specified name.
- Parameters
-
recordName [in] Record name.
- Returns
- Returns true if and only if the predefined table object contains the specified named record object.
Reimplemented from OdDbSymbolTable.
◆ newIterator()
|
virtual |
Returns an Iterator object that can be used to traverse through record objects in the predefined table object.
- Parameters
-
atBeginning [in] true - to start at the beginning, or false - to start at the end. skipDeleted [in] true - to iterate only unerased records, or false - to iterate through unerased and erased records.
Reimplemented from OdDbSymbolTable.
◆ ODDB_DECLARE_MEMBERS()
| OdDbBlockTable::ODDB_DECLARE_MEMBERS | ( | OdDbBlockTable | ) |
◆ subGetClassID()
Overridables
Reimplemented from OdDbObject.
The documentation for this class was generated from the following file: