OdDbObject Class

Class Hierarchy

Syntax

C++

class OdDbObject : public OdGiDrawable;

File

DbObject.h

Description

This class is the base class for all objects contained in an OdDbDatabase instance (OdDb objects).

Remarks

Creating and Deleting Database Objects

Database objects are normally created by calling OdDbXXXXX::createObject(). When an object is created, it will be in kOpenForWrite mode. The delete operator should never be called on database objects. Instead, erase() should be called, which marks the object as erased.
OdDbObject instances should be created by calling the createObject() method.
OdDbObject instances are created in kOpenForWrite mode.
Depending on other OdDbObject instances while constructing or deleting instances is prohibited.
OdDbObject instances should be deleted from an OdDbDatabase with erase().
Never access a pointer to a closed object.
The delete operator must never be called on OdDbObject instances. Instead, the erase() method should be called, which marks this object as erased.

Accessing Database Objects

Database objects must be opened before they can be accessed.
Given a valid OdDbObjectId, a database object is opened by calling OdDbObjectId::safeOpenObject().
Database objects should be opened in the most restrictive mode possible, and should be released immediately when access is no longer needed.

Object may be opened in any one of the following modes:

Mode	Description
OdDb::kForRead	Allows operations that do not modify this object.
	A database object can be opened in this mode any number of times (simultaneously),
	if has not open in OdDb::kForWrite or OdDb::kForNotify mode.
	An exception will be thrown if any type of write operation is attempted
	on an object open in this mode.
OdDb::kForWrite	Allows read and write operations to be performed on this object.
	An database object can be opened in this mode only if it is not
	already open in any mode.
OdDb::kForNotify	This object is opened for notification purposes.
	A database object can be opened in this mode so long as it is
	not already open in kNotify mode.

See Also

OdDbObjectId
OdDbDatabase

Corresponding C++ library: TD_Db

Group

OdDb Classes

Public Methods

	Name	Description
	~OdDbObject

OdDbObject Methods

	Name	Description
	addPersistentReactor	Adds the specified persistent reactor to this object's reactor list.
	addReactor	Adds the specified transient reactor to this object's reactor list.
	addRef	Increments the reference count of this object.
	appendToOwner	This function appends this object to the specified owner object during the deep or wblock clone operation.
	applyPartialUndo	Notification function called each time an Undo operation is performed this object is using partial Undo.
	assertNotifyEnabled	Throws an exception if this object is not open OdDb::kForNotify.
	assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead.
	assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications.
	audit	Perform an audit operation on this object.
	composeForLoad	After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data.
	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.)
	copied	Notification function called whenever the notifying object has had its clone() member function called.
	copyFrom	Copies the contents of the specified object into this object when possible.
	createExtensionDictionary	Creates an OdDbDictionary extension dictionary of this object.
	createXrecord	Creates or retrieves the specified Xrecord in this object's extension dictionary.
	database	Returns the OdDbDatabase that contains this object.
	decomposeForSave	This is the overview for the decomposeForSave method overload.
	deepClone	Performs a deep clone of this object.
	disableUndoRecording	Controls the undo recording of this object in OdDbDatabase.
	downgradeOpen	Downgrades this object from OdDb::kForWrite to OdDb::kForRead
	drawable	Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL.
	dwgIn	Reads the .dwg file format data of this object from the specified file.
	dwgInFields	Reads the .dwg file data of this object.
	dwgOut	Writes the .dwg file format data of this object to the specified filer.
	dwgOutFields	Writes the .dwg file data of this object.
	dxfIn	Reads the DXF format data of this object from the specified filer.
	dxfInFields	Reads the DXF data of this object.
	dxfInFields_R12	Reads the DXF R12 format data of this object.
	dxfOut	Writes the DXF format data of this object to the specified filer.
	dxfOutFields	Writes the DXF data of this object.
	dxfOutFields_R12	Writes the DXF data of this object.
	erase	Sets the erased mode of this object.
	erased	Notification function called whenever an object has been erased or unerased.
	extensionDictionary	Returns the Object ID of this object's extension dictionary.
	getClassID	Returns the CLSID value associated with this object.
	getDbHandle	Returns the persistent handle of this database object.
	getField	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.
	getPersistentReactors	Returns Object IDs of this object's persistent reactors.
	getTransientReactors	Returns this object's transient reactors.
	goodbye	Notification function called just before an object is deleted from memory.
	gsNode	Returns the OdGsCache of an OdGiDrawable object.
	handle	Returns the persistent handle of this database object.
	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.
	hasFields	Returns true if and only if this object has fields.
	hasPersistentReactor	This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false.
	hasSaveVersionOverride	Returns true if and only if this object has its bit set to override the filer version.
	id	Returns the database ID corresponding to this object.
	isAProxy	Returns true if and only if this object is a proxy object or entity.
	isDBRO	Returns true if and only this object is a database -resident object.
	isErased	Returns true if and only if this object is marked as erased.
	isEraseStatusToggled	Returns true if and only if this object's erased status has been toggled since it was opened.
	isModified	Returns true if and only if this object's assertWriteEnabled() has been called since it was opened.
	isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified.
	isModifiedXData	Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened.
	isNewObject	Returns true if and only if this object has not been closed since it was created.
	isNotifyEnabled	Returns true if and only if this object is open OdDb::kForNotify.
	isNotifying	Returns true if and only if this object is sending notification.
	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.
	isPersistent	Return true if and only if this object is database -resident (DBRO).
	isReadEnabled	Returns true if and only if this object is open OdDb::kForRead.
	isReallyClosing	Returns true if and only if a call to close would completely close this object at this time.
	isUndoing	Returns true if and only if this object is taking part in an Undo operation.
	isWriteEnabled	Returns true if and only if this object is open OdDb::kForWrite.
	mergeStyle	Returns the merge style of this object.
	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.
	modifiedGraphics	Notification function called whenever an object derived from OdDbEntity is modified.
	modifiedXData	Notification function called whenever the XData has been written to the notifying object.
	modifyUndone	Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications.
	numRefs	Returns the reference count of this object.
	objectClosed	Notification function called immediately before an object is closed.
	objectId	Returns the Object ID of this object.
	ODDB_DECLARE_MEMBERS
	openedForModify	Notification function called whenever an object is opened for modify OdDb::kForWrite.
	ownerId	Returns the Object ID of this object's owner.
	reappended	Notification function called whenever a Redo process processes the reappending of the notifying object to the database.
	recvPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed.
	release	Decrements the reference count of this object.
	releaseExtensionDictionary	Releases and erases this object's extension dictionary if it exists and is empty.
	removeField	This is the overview for the removeField method overload.
	removePersistentReactor	Removes the specified persistent reactor from this object's reactor list.
	removeReactor	Removes the specified transient reactor from this object's reactor list.
	saveAsClass
	setField	Adds the specified field to the field dictionary of this object.
	setGsNode	Assigns the specified OdGsCache to the calling object.
	setHasSaveVersionOverride	Controls the flag specifying that this object overrides the save filer version.
	setOdDbObjectIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid.
	setOwnerId	Sets this object's ownerId data member.
	setXData	Sets the XData of this object.
	subClose	Called as the first operation as this object is being closed, for database -resident objects only.
	subErase	Called as the first operation as this object is being erased or unerased.
	subHandOverTo	Called as the first operation of the handOverTo function.
	subObjModified	Notification function called whenever a method of the specified subobject has called assertWriteEnabled()
	subOpen	Notification function called by the Drawings framework immediately before an object is opened.
	subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
	subSwapIdWith	Called as the first operation of swapIdWith
	subViewportDraw
	subWorldDraw
	swapIdWith	Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object.
	unappended	Notification function called whenever the Undo process processes the appending of the notifying object to the database.
	undoFiler	Returns the undo filer associated with this object.
	upgradeOpen	Upgrades this object from OdDb::kForRead to OdDb::kForWrite.
	wblockClone	Performs a shallow clone of this object.
	xData	Returns a linked list of ResBufs containing a copy of the XData of this object.
	xDataTransformBy	Applies the 3D transformation matrix to the XData of this object.
	xmitPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed.

Send feedback about this topic