#include <DbDictionary.h>
Protected Member Functions | |
| OdDbDictionary () | |
 Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdDbObjectPtr | subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| virtual OdDbObjectPtr | subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class implements database -resident object dictionaries.
- Remarks
Each instance of OdDbDictionary is a single container object, in which entries are searched, added, modified, and deleted.
Each OdDbDictionary entry associates a unique name (key) string with a unique OdDbObject. Anonymous names are signified by specifying a name starting with an asterisk; e.g., *U. A unique name (also starting with an asterisk) will be constructed for the entry. Entry names honor the rules of Symbol names: Names may be any length. Names are case-insensitve. Names may not contain any of the following characters: | * \ : ; < > ? " , equals.
- See also
- OdDbDictionaryIterator
Corresponding C++ library: TD_Db
<group OdDb_Classes>
Definition at line 134 of file DbDictionary.h.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| kMaxSuggestNameSize | |
Definition at line 299 of file DbDictionary.h.
Constructor & Destructor Documentation
◆ OdDbDictionary()
|
protected |
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.
◆ 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 OdDbDictionaryWithDefault.
◆ 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 OdDbDictionaryWithDefault.
◆ 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 OdDbDictionaryWithDefault.
◆ 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 OdDbDictionaryWithDefault.
◆ erased()
|
virtual |
Notification function called whenever an object has been erased or unerased.
- Parameters
-
pObject [in] Pointer to the object that was erased/unerased. erasing [in] True if and only if this object is being erased.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ getAt() [1/2]
| OdDbObjectPtr OdDbDictionary::getAt | ( | const OdString & | name, |
| OdDb::OpenMode | mode | ||
| ) | const |
Returns the OdDbObject associated with the specified name (key) in this Dictionary object.
- Parameters
-
name [in] Entry name. mode [in] Mode in which to open the object.
- Remarks
- Opens the associated OdDbObject in the specified mode.
Returns a null SmartPointer if the specified entry could not be opened.
◆ getAt() [2/2]
| OdDbObjectId OdDbDictionary::getAt | ( | const OdString & | name, |
| OdResult * | pStatus = 0 |
||
| ) | const |
Returns the OdDbObject associated with the specified name (key) in this Dictionary object.
- Parameters
-
name [in] Entry name. pStatus [out] Receives eOk if successful, or an appropriate error code if not.
- Remarks
- Opens the associated OdDbObject in the specified mode.
Returns a null Object ID if the specified entry could not be opened.
◆ goodbye()
|
virtual |
Notification function called just before an object is deleted from memory.
- Parameters
-
pObject [in] Pointer to the object that is being deleted.
- Remarks
- An object is deleted when its reference count reaches 0.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ has() [1/2]
| bool OdDbDictionary::has | ( | const OdDbObjectId & | objectId | ) | const |
Returns true if and only if this Dictionary object has an entry with the specified Object ID.
- Parameters
-
objectId [in] Object ID.
◆ has() [2/2]
| bool OdDbDictionary::has | ( | const OdString & | name | ) | const |
Returns true if and only if this Dictionary object has an entry with the specified name (key).
- Parameters
-
name [in] Entry name.
◆ isTreatElementsAsHard()
| bool OdDbDictionary::isTreatElementsAsHard | ( | ) | const |
Returns true if and only if this Dictionary object is the hard owner of its elements.
- Remarks
- Hard ownership protects the elements from purge. Soft ownership does not.
◆ mergeStyle()
|
virtual |
Returns the merge style for this dictionary object.
Reimplemented from OdDbObject.
◆ nameAt()
| OdString OdDbDictionary::nameAt | ( | const OdDbObjectId & | objectId | ) | const |
Returns the entry name (key) of the specified object in this Dictionary object.
- Parameters
-
objectId [in] Object ID.
- Remarks
- Returns an empty string if objectId is not in this Dictionary object.
◆ newIterator()
| OdDbDictionaryIteratorPtr OdDbDictionary::newIterator | ( | OdRx::DictIterType | iterType = OdRx::kDictCollated | ) | const |
Returns a new interator that can be used to traverse the entries in this Dictionary object.
- Parameters
-
iterType [in] Type of Iterator.
- Remarks
- The Iterator type can be one of the following:
Description OdRx::kDictCollated Traverses the entries in the order they were added to the dictionary. OdRx::kDictSorted Traverses the entries in alphabetical order by key value.
◆ numEntries()
| OdUInt32 OdDbDictionary::numEntries | ( | ) | const |
Returns the number of entries in this Dictionary object.
◆ remove() [1/2]
| void OdDbDictionary::remove | ( | const OdDbObjectId & | objectId | ) |
Removes the entry with the specified Object ID from this Dictionary object, and returns the Object ID of the removed entry.
- Parameters
-
name [in] Entry name. objectId [in] Object ID.
- Remarks
- Only the dictionary entry is removed; the associated object remains in the database without an owner. The dictionary is removed as a persistent reactor on the associated object.
◆ remove() [2/2]
| OdDbObjectId OdDbDictionary::remove | ( | const OdString & | name | ) |
Removes the entry with the specified name (key) from this Dictionary object, and returns the Object ID of the removed entry.
- Parameters
-
name [in] Entry name.
- Remarks
- Only the dictionary entry is removed; the associated object remains in the database without an owner. The dictionary is removed as a persistent reactor on the associated object.
◆ setAt()
| OdDbObjectId OdDbDictionary::setAt | ( | const OdString & | name, |
| OdDbObject * | newValue | ||
| ) |
Sets the value for the specified entry in this Dictionary object.
- Returns
- Returns the Object ID of the newly added entry.
If an entry the specified name exists in the dictionary, it is erased, and a new entry created.
If an entry for this name does not exist in this dictionary, a new entry is created.
- Parameters
-
name [in] Name of entry to be changed. newValue [in] Database object to be added.
◆ setMergeStyle()
|
virtual |
Sets the merge style for this dictionary object.
- Parameters
-
mergeStyle [in] Merge style.
◆ setName()
Changes the name (key) of the specified entry in this Dictionary object.
- Parameters
-
oldName [in] Name of entry to change. newName [in] New name for the entry.
- Returns
- Returns true and only if the entry name was successfully changed.
◆ setTreatElementsAsHard()
| void OdDbDictionary::setTreatElementsAsHard | ( | bool | doIt | ) |
Sets the hard ownership property for this Dictionary object.
- Parameters
-
hard [in] Controls ownership.
- Remarks
- Hard ownership protects the elements from purge. Soft ownership does not.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subGetClassID()
Reimplemented from OdDbObject.
◆ suggestName()
| OdString OdDbDictionary::suggestName | ( | const OdString & | strFilePath, |
| const int | nMaxLength = kMaxSuggestNameSize |
||
| ) | const |
Returns a string suitable to be used as dictionary Key for this dictionary object. The string is unique for this dictionary object and is as close to file name as possible.
- Parameters
-
strFilePath [in] File path. nMaxLength [in] Maximum length of name generated.
The documentation for this class was generated from the following file: