OdBmDatabase Class

Class Hierarchy

Syntax

C++

class OdBmDatabase : public OdBmObject;

File

BmDatabase.h

Description

This class implement functionality for BimRv database management.

Group

Database Classes

Public Methods

OdBmObject Class

	Name	Description
	~OdBmObject	A destructor for the BimRv object.

OdTfObject Methods

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.

OdBmObject Class

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	addRef	Increments the counter of references to the object.
	clone	Clones the object.
	database	Retrieves the related database object.
	drawableType	Retrieves the drawable type of the object.
	getGeomExtents	Returns a WCS bounding box that represents the extents of this object.
	getListParams	Retrieves the list of built-in parameters.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperties	Retrieves the array of object's properties.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	gsNode	Retrieves graphical system cache associated with the object.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	id	Retrieves the object's identifier in the associated database.
	isPersistent	Retrieves whether the object is persistent or not.
	numRefs	Retrieves the current quantity of references to the object.
	release	Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setDatabaseDefaults	Applies the default properties of the specified database to this entity.
	setGsNode	Assigns the specified OdGsCache to this object.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	subRegenSupportFlags	Retrieves the current regeneration support flags set for the object.
	subSetAttributes	Sets the vectorization attributes of the object, and returns its attribute flags.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
	subViewportDraw	Implements viewport-dependent rendering.
	subWorldDraw	Implements the mechanism for rendering the object.

OdBmDatabase Class

	Name	Description
	addElement	Adds a new element and registers it in the database.
	appServices	Retrieves the host application service associated with the database.
	database	Retrieves the related database object.
	formatter	Retrieves the unit formatter for the database. returns A smart pointer to an OdBmUnitsFormatter object that represents the currently used unit formatter.
	formatter	Retrieves the unit formatter for the database as a constant object. returns A smart pointer to an OdBmUnitsFormatter object that represents the currently used unit formatter.
	getActiveDBDrawingId	Retrieves the active OdBmDBDrawing object from the database.
	getActiveSketchPlaneId	Retrieves the OdBmObjectId of active SketchPlane element from the active DBView.
	getAppInfo	Retrieves the database manager of a specified type.
	getAppInfo	Retrieves the database manager of a specified type.
	getAppInfoArr	Retrieves the array of the database trackers.
	getAppInfoManager	Retrieves application information manager for the database.
	getBackElementTable	This method is used for getting database back elements for rendering purposes. For internal use only. It is strictly recommended DO NOT use it in your custom applications.
	getBasicFileInfo	Retrieves the basic information about the database's file.
	getCategoriesData	Retrieves categories contained in the database.
	getContentDocTable	Retrieves the document content table from the database.
	getContents	Retrieves the database contents.
	getContentTable	Retrieves the content table from the database.
	getCorruptDocument	Retrieves whether the database contains a corrupted document.
	getDevBranchInfo	Retrieves the development branch information for the database.
	getDisplayUnitSystem	Retrieves the display unit system.
	getDocIncrementalTable	This is getDocIncrementalTable, a member of class OdBmDatabase.
	getElementTable	Retrieves the table of database elements.
	getExecutedUpgrades	Retrieves upgrades that were executed for the database.
	getExServicesUsed	Retrieves external services that were used within the database.
	getFamilyManager	Retrieves the family manager from the family database (contained in a .rfa file).
	getFilename	Retrieves the name of the file related to the database.
	getFrontElementTable	This method is used for getting database front elements for rendering purposes. For internal use only. It is strictly recommended DO NOT use it in your custom applications.
	getHistory	Retrieves the document history from the database.
	getImportedDatabases	Retrieves the set of simplified databases of imported families.
	getIsCoreDocument	Retrieves whether the database contains the core document.
	getIsGroupFile	Retrieves whether the database is associated with a group file.
	getMidElementTable	This method is used for getting database middle elements for rendering purposes. For internal use only. It is strictly recommended DO NOT use it in your custom applications.
	getNobleSecondaryData	Retrieves the noble secondary data from the database.
	getObjectId	Retrieves the identifier of the database-resident element by its handle.
	getObjectId	Retrieves the identifier of the database-resident element by its handle.
	getOriginalFileVersion	Retrieves the version of the original file related to the database.
	getOwnerFamilyContainingGroupId	Retrieves the identifier of the owner family for the database with group identifier.
	getOwnerFamilyId	Retrieves the identifier of the owner family for the family database (i.e. for .rfa files).
	getPartitionTable	Retrieves the partition table from the database.
	getRootDatabase	Retrieves the root database.
	getSoftwareBuild	Retrieves the list software applications that were used for saving the database content in a file.
	getSteelModelInfo	Retrieves the information about the steel model from the database.
	getStyleSettings	Retrieves the current style settings applied to the database.
	initialize	Initializes the database.
	isEditMode	Retrieves whether the Edit mode is enabled for the database.
	isModel	Retrieves whether the database is allocated in a .rvt file
	isWorkshared	Retrieves whether the Worksharing mode is enabled for the database.
	latestFileVersion	Retrieves the latest version of the file where the database is allocated.
	newElemTableIterator	Creates a new element table iterator. Iterator provides the sequential access to elements from database's element table.
	newElemTableIteratorById	Creates a new element table iterator. Iterator provides the sequential access to element ids from database's element table.
	newIterator	Creates a new element table iterator. Iterator provides the sequential access to elements from the database.
	newIteratorById	Creates a new element table iterator. Iterator provides the sequential access to element ids from the database.

OdBmObject Nested Types

OdBmObject Class

Name	Description
ItemIndexType	This is nested type OdBmObject::ItemIndexType.
PropertyIndexType	This is nested type OdBmObject::PropertyIndexType.

Send feedback about this topic