#include <DbSymbolTable.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the predefined table object, which represents a container for
storing and accessing of named record objects in the database.
- See also
- <link db_datasheet_sample_root, Example of Selecting a Predefined Table Object>
<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>
OdDbSymbolTableRecord class
Definition at line 85 of file DbSymbolTable.h.
Constructor & Destructor Documentation
◆ OdDbSymbolTable()
| OdDbSymbolTable::OdDbSymbolTable | ( | ) |
Builds an instance of the predefined table object.
Applications typically will not use this constructor, insofar as the database object creates own instance of all predefined tables.
Member Function Documentation
◆ add()
|
virtual |
Adds the specified named record object to the predefined table object and returns the Object ID of the added record object.
- Parameters
-
pRecord [in] Pointer to the existing named record object to be added.
- 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.
- See also
- <link db_datasheet_add_delete, Adding, Naming, Deleting, Recovering Records>
OdError_DuplicateRecordName class
Reimplemented in OdDbBlockTable, OdDbDimStyleTable, OdDbLinetypeTable, OdDbTextStyleTable, and OdDbViewportTable.
◆ 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 OdDbBlockTable, OdDbDimStyleTable, and OdDbLinetypeTable.
◆ 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 OdDbBlockTable, OdDbDimStyleTable, and OdDbLinetypeTable.
◆ 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.
- Returns
- Returns the filer status.
This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented from OdDbObject.
Reimplemented in OdDbBlockTable, and OdDbViewportTable.
◆ 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 OdDbDimStyleTable.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be 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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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.
◆ dxfOut()
|
virtual |
Writes the DXF format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.
Reimplemented from OdDbObject.
Reimplemented in OdDbLinetypeTable.
◆ 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 OdDbDimStyleTable.
◆ 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.
◆ getAt() [1/2]
|
virtual |
Searches the named record object in the predefined table object using the specified name.
- Parameters
-
sName [in] Record name as a String value up to 255 characters long. getErasedRecord [in] If and only if true, erased records will be opened or retrieved.
- See also
- <link db_datasheet_get_check, Getting and Checking Records>
Reimplemented in OdDbBlockTable, and OdDbLinetypeTable.
◆ getAt() [2/2]
|
virtual |
Searches the named record object in the predefined table object using the specified name and opnes it in the specified mode.
- Parameters
-
sName [in] Record name as a String value up to 255 characters long. openMode [in] Mode in which to open the record. getErasedRecord [in] If and only if true, erased records will be opened or retrieved.
- Returns
- Returns a SmartPointer to the object if successful, otherwise a null SmartPointer.
- See also
- <link db_datasheet_get_check, Getting and Checking Records>
Reimplemented in OdDbBlockTable, and OdDbLinetypeTable.
◆ has() [1/2]
|
virtual |
Determines whether the named record object exists in the predefined table object using the specified object ID, and returns True if and only if the predefined table object contains the specified named record object.
- Parameters
-
objectId [in] Object ID.
- See also
- <link db_datasheet_get_check, Getting and Checking Records>
Reimplemented in OdDbBlockTable, and OdDbLinetypeTable.
◆ has() [2/2]
|
virtual |
Determines whether the named record object exists in the predefined table object using the specified name, and returns True if and only if the predefined table object contains the specified named record object.
- Parameters
-
sName [in] Record name as a String value up to 255 characters long.
- See also
- <link db_datasheet_get_check, Getting and Checking Records>
Reimplemented in OdDbBlockTable, and OdDbLinetypeTable.
◆ 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.
- See also
- <link db_datasheet_iterate, Iterating through Records>
Reimplemented in OdDbBlockTable, and OdDbLinetypeTable.
◆ ODDB_DECLARE_MEMBERS()
| OdDbSymbolTable::ODDB_DECLARE_MEMBERS | ( | OdDbSymbolTable | ) |
The documentation for this class was generated from the following file: