OdDbDictionary Class

Syntax

C++

class OdDbDictionary : public OdDbObject;

Description

This class implements database -resident object dictionaries.

Corresponding C++ library: TD_Db

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-insensitive.
- Names may not contain any of the following characters: | * : ; < > ? " , equals.

Class Hierarchy

File: DbDictionary.h

Module: API Reference

See Also

OdDbDictionaryIterator class

Methods

Show:Inherited

No members matching the current filter

~OdDbObject

(Inherited from OdDbObject)

Friends

Show:Inherited

No members matching the current filter

class OdDbObjectImpl	(Inherited from OdDbObject)
class OdDbObjectOverrule	(Inherited from OdDbObject)
class OdDbPropertiesOverrule	(Inherited from OdDbObject)
class OdDbSystemInternals	(Inherited from OdDbObject)

Methods

Show:Inherited

No members matching the current filter

ODDB_DECLARE_MEMBERS	(Inherited from OdDbObject)
addPersistentReactor	Adds the specified persistent reactor to this object's reactor list. (Inherited from OdDbObject)
addReactor	Adds the specified transient reactor to this object's reactor list. (Inherited from OdDbObject)
addRef	Increments the reference count of this object. (Inherited from OdDbObject)
appendToOwner	This function appends this object to the specified owner object during the deep or wblock clone operation. (Inherited from OdDbObject)
applyPartialUndo	Notification function called each time an Undo operation is performed this object is using partial Undo.
applyPartialUndo	Notification function called each time an Undo operation is performed this object is using partial Undo. (Inherited from OdDbObject)
assertNotifyEnabled	Throws an exception if this object is not open OdDb::kForNotify. (Inherited from OdDbObject)
assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead. (Inherited from OdDbObject)
assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDbObject)
audit	Perform an audit operation on this object. (Inherited from OdDbObject)
begin	Returns an iterator that points at the beginning of the dictionary. To be used to traverse through entries via "range-based for" loop. Traverses the entries in the order they were added to the dictionary.
composeForLoad	After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data. (Inherited from OdDbObject)
convertForSave	The method should be called from decomposeForSave() of custom container objects for owned child objects. It calls child's decomposeForSave() method plus performs other required actions (handOverTo, exchanging XData, etc.) (Inherited from OdDbObject)
copied	Notification function called whenever the notifying object has had its clone() member function called. (Inherited from OdDbObject)
copyFrom	Copies the contents of the specified object into this object when possible. (Inherited from OdDbObject)
createExtensionDictionary	Creates an OdDbDictionary extension dictionary of this object. (Inherited from OdDbObject)
createXrecord	Creates or retrieves the specified Xrecord in this object's extension dictionary. (Inherited from OdDbObject)
database	Returns the OdDbDatabase that contains this object. (Inherited from OdDbObject)
decomposeForSave(OdDb::DwgVersion, OdDbObjectId&, bool&)	This is the overview for the decomposeForSave method overload.
deepClone	Performs a deep clone of this object. (Inherited from OdDbObject)
disableUndoRecording	Controls the undo recording of this object in OdDbDatabase. (Inherited from OdDbObject)
downgradeOpen	Downgrades this object from OdDb::kForWrite to OdDb::kForRead (Inherited from OdDbObject)
drawable	Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbObject)
dwgIn	Reads the .dwg file format data of this object from the specified file. (Inherited from OdDbObject)
dwgInFields	Reads the .dwg file data of this object.
dwgInFields	Reads the .dwg file data of this object. (Inherited from OdDbObject)
dwgOut	Writes the .dwg file format data of this object to the specified filer. (Inherited from OdDbObject)
dwgOutFields	Writes the .dwg file data of this object.
dwgOutFields	Writes the .dwg file data of this object. (Inherited from OdDbObject)
dxfIn	Reads the DXF format data of this object from the specified filer. (Inherited from OdDbObject)
dxfInFields	Reads the DXF data of this object.
dxfInFields	Reads the DXF data of this object. (Inherited from OdDbObject)
dxfInFields_R12	Reads the DXF R12 format data of this object. (Inherited from OdDbObject)
dxfOut	Writes the DXF format data of this object to the specified filer. (Inherited from OdDbObject)
dxfOutFields	Writes the DXF data of this object.
dxfOutFields	Writes the DXF data of this object. (Inherited from OdDbObject)
dxfOutFields_R12	Writes the DXF data of this object. (Inherited from OdDbObject)
end	Returns an iterator that points at the end of the dictionary, to support "range-based for" loop.
erase	Sets the erased mode of this object. (Inherited from OdDbObject)
erased	Notification function called whenever an object has been erased or unerased.
erased	Notification function called whenever an object has been erased or unerased. (Inherited from OdDbObject)
extensionDictionary	Returns the Object ID of this object's extension dictionary. (Inherited from OdDbObject)
getAt(const OdString&, OdDb::OpenMode)	This is the overview for the getAt method overload.
getClassID	Returns the CLSID value associated with this object. (Inherited from OdDbObject)
getDbHandle	Returns the persistent handle of this database object. (Inherited from OdDbObject)
getField(const OdString&)	This is the overview for the getField method overload.
getFieldDictionary()	This is the overview for the getFieldDictionary method overload.
getObjectSaveVersion	Returns the drawing and maintenance release version into which this object must be stored. (Inherited from OdDbObject)
getPersistentReactors	Returns Object IDs of this object's persistent reactors. (Inherited from OdDbObject)
getTransientReactors	Returns this object's transient reactors. (Inherited from OdDbObject)
goodbye	Notification function called just before an object is deleted from memory.
goodbye	Notification function called just before an object is deleted from memory. (Inherited from OdDbObject)
gsNode	Returns the OdGsCache of an OdGiDrawable object. (Inherited from OdDbObject)
handOverTo	Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list. (Inherited from OdDbObject)
handle	Returns the persistent handle of this database object. (Inherited from OdDbObject)
has(const OdDbObjectId&)	This is the overview for the has method overload.
hasFields	Returns true if and only if this object has fields. (Inherited from OdDbObject)
hasPersistentReactor	This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false. (Inherited from OdDbObject)
hasSaveVersionOverride	Returns true if and only if this object has its bit set to override the filer version. (Inherited from OdDbObject)
id	Returns the database ID corresponding to this object. (Inherited from OdDbObject)
isAProxy	Returns true if and only if this object is a proxy object or entity. (Inherited from OdDbObject)
isDBRO	Returns true if and only this object is a database -resident object. (Inherited from OdDbObject)
isEraseStatusToggled	Returns true if and only if this object's erased status has been toggled since it was opened. (Inherited from OdDbObject)
isErased	Returns true if and only if this object is marked as erased. (Inherited from OdDbObject)
isModified	Returns true if and only if this object's assertWriteEnabled() has been called since it was opened. (Inherited from OdDbObject)
isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDbObject)
isModifiedXData	Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened. (Inherited from OdDbObject)
isNewObject	Returns true if and only if this object has not been closed since it was created. (Inherited from OdDbObject)
isNotifyEnabled	Returns true if and only if this object is open OdDb::kForNotify. (Inherited from OdDbObject)
isNotifying	Returns true if and only if this object is sending notification. (Inherited from OdDbObject)
isOdDbObjectIdsInFlux	Returns true if and only if this object's Object ID is not valid because the OdDbObject::subDeepClone or OdDbObject::subWblockClone() have yet to be completed. (Inherited from OdDbObject)
isPersistent	Return true if and only if this object is database -resident (DBRO). (Inherited from OdDbObject)
isReadEnabled	Returns true if and only if this object is open OdDb::kForRead. (Inherited from OdDbObject)
isReallyClosing	Returns true if and only if a call to close would completely close this object at this time. (Inherited from OdDbObject)
isTreatElementsAsHard	Returns true if and only if this Dictionary object is the hard owner of its elements.
isUndoing	Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDbObject)
isWriteEnabled	Returns true if and only if this object is open OdDb::kForWrite. (Inherited from OdDbObject)
mergeStyle	Returns the merge style for this dictionary object.
mergeStyle	Returns the merge style of this object. (Inherited from OdDbObject)
modified	Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed. (Inherited from OdDbObject)
modifiedGraphics	Notification function called whenever an object derived from OdDbEntity is modified. (Inherited from OdDbObject)
modifiedXData	Notification function called whenever the XData has been written to the notifying object. (Inherited from OdDbObject)
modifyUndone	Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications. (Inherited from OdDbObject)
nameAt	Returns the entry name (key) of the specified object in this Dictionary object.
newIterator	Returns a new iterator that can be used to traverse the entries in this Dictionary object.
numEntries	Returns the number of entries in this Dictionary object.
numRefs	Returns the reference count of this object. (Inherited from OdDbObject)
objectClosed	Notification function called immediately before an object is closed. (Inherited from OdDbObject)
objectId	Returns the Object ID of this object. (Inherited from OdDbObject)
openedForModify	Notification function called whenever an object is opened for modify OdDb::kForWrite. (Inherited from OdDbObject)
ownerId	Returns the Object ID of this object's owner. (Inherited from OdDbObject)
reappended	Notification function called whenever a Redo process processes the reappending of the notifying object to the database. (Inherited from OdDbObject)
recvPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject)
release	Decrements the reference count of this object. (Inherited from OdDbObject)
releaseExtensionDictionary	Releases and erases this object's extension dictionary if it exists and is empty. (Inherited from OdDbObject)
remove(const OdDbObjectId&)	This is the overview for the remove method overload.
removeField(OdDbObjectId)	This is the overview for the removeField method overload.
removePersistentReactor	Removes the specified persistent reactor from this object's reactor list. (Inherited from OdDbObject)
removeReactor	Removes the specified transient reactor from this object's reactor list. (Inherited from OdDbObject)
saveAsClass	!DOM (Inherited from OdDbObject)
setAt	Sets the value for the specified entry in this Dictionary object.
setField	Adds the specified field to the field dictionary of this object. (Inherited from OdDbObject)
setGsNode	Assigns the specified OdGsCache to the calling object. (Inherited from OdDbObject)
setHasSaveVersionOverride	Controls the flag specifying that this object overrides the save filer version. (Inherited from OdDbObject)
setMergeStyle	Sets the merge style for this dictionary object.
setName	Changes the name (key) of the specified entry in this Dictionary object.
setOdDbObjectIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDbObject)
setOwnerId	Sets this object's ownerId data member. (Inherited from OdDbObject)
setTreatElementsAsHard	Sets the hard ownership property for this Dictionary object.
setXData	Sets the XData of this object. (Inherited from OdDbObject)
subClose	Called as the first operation as this object is being closed, for database -resident objects only.
subClose	Called as the first operation as this object is being closed, for database -resident objects only. (Inherited from OdDbObject)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDbObject)
subGetClassID	overridables
subHandOverTo	Called as the first operation of the handOverTo function. (Inherited from OdDbObject)
subObjModified	Notification function called whenever a method of the specified subobject has called assertWriteEnabled() (Inherited from OdDbObject)
subOpen	Notification function called by the Drawings framework immediately before an object is opened. (Inherited from OdDbObject)
subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits. (Inherited from OdDbObject)
subSwapIdWith	Called as the first operation of swapIdWith (Inherited from OdDbObject)
subViewportDraw	(Inherited from OdDbObject)
subWorldDraw	(Inherited from OdDbObject)
suggestName	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.
swapIdWith	Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object. (Inherited from OdDbObject)
unappended	Notification function called whenever the Undo process processes the appending of the notifying object to the database. (Inherited from OdDbObject)
undoFiler	Returns the undo filer associated with this object. (Inherited from OdDbObject)
upgradeOpen	Upgrades this object from OdDb::kForRead to OdDb::kForWrite. (Inherited from OdDbObject)
wblockClone	Performs a shallow clone of this object. (Inherited from OdDbObject)
xData	Returns a linked list of ResBufs containing a copy of the XData of this object. (Inherited from OdDbObject)
xDataTransformBy	Applies the 3D transformation matrix to the XData of this object. (Inherited from OdDbObject)
xmitPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject)

Links

OdDbDictionary Methods

Relief for ODA Team in Ukraine