#include <DbSymbolTableRecord.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the named record object, which is the base class for all record objects in the database.
- See also
- <link db_datasheet_sample_select, Example of Using the Record-Table Interface for Selecting Objects>
<link db_database_object_sample_about, Example of Using the Record-Table and Dictionary Interfaces for Getting Information about Objects>
- See also
- <link db_datasheet, Working with Predefined Tables of Named Records>
OdDbSymbolTable class
Definition at line 53 of file DbSymbolTableRecord.h.
Constructor & Destructor Documentation
◆ OdDbSymbolTableRecord()
| OdDbSymbolTableRecord::OdDbSymbolTableRecord | ( | ) |
Builds an instance of the named record object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_datasheet_add_delete, Adding, Naming, Deleting, Recovering Records>
Member Function Documentation
◆ appendToOwner()
|
virtual |
This function appends this object to the specified owner object during the deep or wblock clone operation.
- Parameters
-
idPair [in] Original-to-clone ID mapping record for this clone. pOwnerObject [in] Pointer to the owner object. idMap [in/out] ID mapping object of the cloning operation in progress.
- Remarks
- This callback is called before the IDs are translated in the target database so the implementer should use only methods certainly not traversing hierarchy in the target database. To follow clone's references properly they should be translated using the ID mapping object.
The default implementation appends this object to OdDbDictionary or throws the eInvalidOwnerObject exception if the owner object is not a kind of dictionary.
- See also
- <link OdDbObject::subDeepClone@OdDbIdMapping&@OdDbObject*@bool@const, subDeepClone()> <link OdDbObject::subWblockClone@OdDbIdMapping&@OdDbObject*@bool@const, subWblockClone()> <link OdDbObject::deepClone@OdDbIdMapping&@OdDbObject*@bool@const, deepClone()> <link OdDbObject::wblockClone@OdDbIdMapping&@OdDbObject*@bool@const, wblockClone()>
Reimplemented from OdDbObject.
◆ copyFrom()
|
virtual |
Copies the contents of other into the messaged object, whenever feasible
Reimplemented from OdDbObject.
Reimplemented in OdDbBlockTableRecord, OdDbAbstractViewTableRecord, and OdDbViewportTableRecord.
◆ 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.
Reimplemented in OdDbAbstractViewTableRecord, OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, OdDbUCSTableRecord, OdDbViewportTableRecord, OdDbViewTableRecord, and OdDbBlockTableRecord.
◆ 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.
Reimplemented in OdDbAbstractViewTableRecord, OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, OdDbUCSTableRecord, OdDbViewportTableRecord, OdDbViewTableRecord, and OdDbBlockTableRecord.
◆ 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.
Reimplemented in OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, OdDbUCSTableRecord, OdDbViewportTableRecord, OdDbViewTableRecord, and OdDbBlockTableRecord.
◆ 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.
Reimplemented in OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, OdDbUCSTableRecord, OdDbViewportTableRecord, OdDbViewTableRecord, and OdDbBlockTableRecord.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
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). 3) 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 OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, OdDbUCSTableRecord, OdDbViewportTableRecord, and OdDbViewTableRecord.
◆ getName()
|
virtual |
Returns the name of the record object (DXF 2).
- See also
- <link db_datasheet_add_delete, Adding, Naming, Deleting, Recovering Records>
◆ isDependent()
| bool OdDbSymbolTableRecord::isDependent | ( | ) | const |
Returns true if and only if this Record object is Xref dependent (DXF 70, bit 0x10).
◆ isResolved()
| bool OdDbSymbolTableRecord::isResolved | ( | ) | const |
Returns true if and only if this Record object is Xref dependent and resolved (DXF 70, bit 0x20).
◆ ODDB_DECLARE_MEMBERS()
| OdDbSymbolTableRecord::ODDB_DECLARE_MEMBERS | ( | OdDbSymbolTableRecord | ) |
◆ setName()
Sets the name for the record object (DXF 2).
- Parameters
-
sName [in] Record name as a String value up to 255 characters long.
- Remarks
- The name is an arbitrary non-empty string that can contain letters, digits, blank spaces, underscores, and some special characters, but cannot contain inadmissible letters (see <link objects_naming, Naming Objects>).
- See also
- <link db_datasheet_add_delete, Adding, Naming, Deleting, Recovering Records>
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
Reimplemented in OdDbDimStyleTableRecord, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbRegAppTableRecord, OdDbTextStyleTableRecord, and OdDbBlockTableRecord.
◆ subSwapIdWith()
|
virtual |
Called as the first operation of swapIdWith
- Parameters
-
otherId [in] Object ID to be swapped with this object's Object ID. swapXdata [in] If and only if true, extended data are swapped. swapExtDict [in] If and only if true, extension dictionaries are swapped.
- Remarks
- This function is notified just before an object is to be opened; giving this function the ability to cancel the object being swapped or perform necessary actions.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subSwapIdWith().
3) If other actions are required before swapping IDs, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
Reimplemented in OdDbViewTableRecord.
The documentation for this class was generated from the following file: