OdDbObjectId Class

Class Hierarchy

Syntax

C++

class OdDbObjectId;

File

DbObjectId.h

Description

This class implements memory-resident ObjectId objects for OdDbDatabase objects.

Remarks

Database objects reference other database objects using ObjectId objects, and a database object pointer can always be obtained from a valid ObjectId objects. The effect of this mechanism is that database objects do not have to reside in memory unless they are explicitly being examined or modified by the user.

The user must explicitly open an object before reading or writing to it, and should release it when the operation is completed. This functionality allows the Drawings to support partial loading of a database, where ObjectId objects exist for all objects in the database, but the actual database objects need not be loaded until they are accessed. It also allows database objects that are not in use to be swapped out of memory, and loaded back in when they are accessed. ObjectId objects are not written out to a DWG/DXF file. If a reference must be preserved to a database object that has been serialized, the object's database handle (OdDbHandle) should be used.

See Also

OdDbHandle
OdDbObject

Corresponding C++ library: TD_Db

Group

OdDb Classes

Public Methods

	Name	Description
	OdDbObjectId	This is the overview for the OdDbObjectId constructor overload.

OdDbObjectId Data Members

	Name	Description
	kNull	The null ObjectId object.

OdDbObjectId Methods

	Name	Description
	bindObject	Binds the specified object.
	convertToRedirectedId	If this ObjectId object has been redirected from another database (possibly an Xref), this function returns the actual ObjectId object for that database.
	database	Returns the database with which this ObjectId object is associated.
	getHandle	Returns the database handle of the object referenced by this ObjectId object.
	getNonForwardedHandle	Returns the database handle of the object referenced by this ObjectId object.
	isEffectivelyErased	Returns true if and only if this object associated with this ObjectId object is erased, or any of its ownership hierarchy have been erased.
	isErased	Returns true if and only if the object associated with this ObjectId object is erased.
	isNull	Returns true and only if this ObjectId object is null.
	isValid	Returns true and only if this ObjectId object references a valid object.
	objectClass
	objectLeftOnDisk
	openObject	This is the overview for the openObject method overload.
	originalDatabase	Returns the original database with which this ObjectId object is associated.
	safeOpenObject	Opens the database object associated with this ObjectId object, in the specified mode, or throws and exception if unsucessful.
	setNull	Sets this Object ID to null.

OdDbObjectId Operators

	Name	Description
	!
	!=
	<
	<=
	=	This is the overview for the = operator overload.
	==
	>
	->
	>=
	OdDbStub*

Send feedback about this topic