#include <DbUnderlayDefinition.h>
Static Public Member Functions | |
| static OdString | dictionaryKey (const OdRxClass *underlayDefinitionType) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
<group OdDb_Classes>
Definition at line 37 of file DbUnderlayDefinition.h.
Member Function Documentation
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [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 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.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented from OdDbObject.
◆ dictionaryKey()
|
static |
◆ dwgInFields()
|
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.
◆ 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 OdDbObject.
◆ dxfInFields()
|
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.
◆ dxfOutFields()
|
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.
◆ getActiveFileName()
| OdString OdDbUnderlayDefinition::getActiveFileName | ( | ) | const |
◆ getItemName()
| OdString OdDbUnderlayDefinition::getItemName | ( | ) | const |
◆ getSourceFileName()
| OdString OdDbUnderlayDefinition::getSourceFileName | ( | ) | const |
◆ getUnderlayItem()
| OdDbUnderlayItemPtr OdDbUnderlayDefinition::getUnderlayItem | ( | ) | const |
◆ isLoaded()
| bool OdDbUnderlayDefinition::isLoaded | ( | ) | const |
◆ load()
◆ ODDB_DECLARE_MEMBERS()
| OdDbUnderlayDefinition::ODDB_DECLARE_MEMBERS | ( | OdDbUnderlayDefinition | ) |
◆ postDefinitionToDb()
|
virtual |
◆ setItemName()
◆ setSourceFileName()
◆ setUnderlayItem()
| void OdDbUnderlayDefinition::setUnderlayItem | ( | const OdString & | sourceFileName, |
| const OdString & | activeFileName, | ||
| OdDbUnderlayItemPtr | pItem | ||
| ) |
◆ unload()
| void OdDbUnderlayDefinition::unload | ( | ) |
The documentation for this class was generated from the following file: