OdDbDatabase Class

Class Hierarchy

Syntax

C++

class OdDbDatabase : public OdDbObject;

File

DbDatabase.h

Description

This class represents a complete drawing file.

TD_Db

	Name	Description
	~OdDbDatabase	Destroys a database instance.

OdDbDatabase Methods

	Name	Description
	abortDeepClone	Terminates a call to deepCloneObjects() or wblockCloneObjects().
	abortTransaction	Aborts the current transaction associated with this database object.
	activeViewportId	Returns the identifier of the active viewport for this database.
	addOdDbObject	Adds an object to this database object, and returns its Object ID.
	addReactor	Adds the specified reactor to this object's reactor list.
	addRef	Increments the reference count of this object.
	addTransactionReactor	Adds a transaction reactor to this database object.
	applyPartialUndo	Applies a partial undo operation.
	approxNumObjects	Returns the approximate number of objects in this database object.
	appServices	Returns the OdDbHostAppServices object associated with this database object.
	audit	Performs an audit operation on the header of this database object.
	auditDatabase	Performs an audit operation on the this entire database object.
	auditInfo	Returns the pointer to OdDbAuditInfo if the database is being loaded from a file in recover modem, otherwise returns Null.
	blockUndoRecording	Blocks or unblocks undo history recording.
	byBlockMaterialId	Returns the identifier of the by-block material for this database.
	byLayerMaterialId	Returns the identifier of the by-layer material for this database.
	cannoscale	Returns the current annotation scale as a context object for this database.
	classDxfName	Returns the class DXF name for the specified class.
	clearUndo	Clears undo history.
	countHardReferences	Returns a count of hard references to each of the specified object IDs.
	countLayouts	Returns the number of layouts in this database object.
	createLayout	Creates a new layout with the specified name in this database object.
	currentLayoutId	Returns the object ID of the active layout of this database object.
	dataLinkDictionary	This is dataLinkDictionary, a member of class OdDbDatabase.
	dataLinkDictionaryId	This is dataLinkDictionaryId, a member of class OdDbDatabase.
	deepCloneObjects	Deep clones a set of objects and appends the clones to the specified owner object.
	deleteLayout	Deletes the specified layout from this database object.
	detailViewStyle	Returns the object ID of the current DetailViewStyle of this database object.
	dimfit	Returns the R14 DIMFIT system variable of this database object.
	dimunit	Returns the R14 DIMUNIT system variable of this database object.
	dwgInFields	Reads the .dwg file data of this object.
	dwgOutFields	Writes the .dwg file data of this object.
	enableGraphicsFlush	Enables graphics flushing.
	endTransaction	Ends the current transaction associated with this database object.
	enqueuePaging	Enqueues the object paging, mark it for paging in next call to pageObjects().
	fileDependencyManager	Returns the OdFileDependencyManager object of this database object.
	findActiveLayout	Returns the name of the active layout of this database object.
	findLayoutNamed	Returns the object ID of the specified layout in this database object.
	flushAllTransactedChanges	Flush all the changes made during first transaction started on this database object.
	flushGraphics	Flushes the graphics in this database.
	formatter	Returns the current formatter for units in this database.
	getActiveLayoutBTRId	Returns the object ID of the BlockTableRecord associated with the active layout of this database object.
	getBlockTableId	Returns the object ID of the BlockTable of this database object.
	getColorDictionaryId	Returns the object ID of the Color dictionary of this database object.
	getDetailViewStyleDictionaryId	Returns the object ID of the DetailViewStyle dictionary of this database object.
	getDIMANNO	Returns true if current dimension style is annotative.
	getDimstyleChildData	Returns the child dimension style data and dimension style object identifier.
	getDimstyleChildId	Returns the identifier of the child dimension style.
	getDimstyleData	Copies the dimension variables of this database object to the specified DimStyleTableRecord.
	getDimstyleParentId	Returns the identifier of the parent dimension style.
	getDimStyleStandardId	Returns the object ID of the "Standard" dimension style object of this database object.
	getDimStyleTableId	Returns the object ID of the DimStyleTable of this database object.
	getFilename	Returns the name of the file associated with this database object.
	getGroupDictionaryId	Returns the object ID of the Group dictionary of this database object.
	getLayerAdskId	Returns the object ID of the specified system layer object of this database object.
	getLayerDefpointsId	Returns the object ID of the "DEFPOINTS" layer object of this database object.
	getLayerStateManager	Returns the OdDbLayerStateManager object of this database object.
	getLayerTableId	Returns the object ID of the LayerTable of this database object.
	getLayerZeroId	Returns the object ID of the "0" layer object of this database object.
	getLayoutDictionaryId	Returns the object ID of the Layout dictionary of this database object.
	getLinetypeByBlockId	Returns the object ID of the "ByBlock" Linetype object of this database object.
	getLinetypeByLayerId	Returns the object ID of the "ByLayer" Linetype object of this database object.
	getLinetypeContinuousId	Returns the object ID of the "Continuous" Linetype object of this database object.
	getLinetypeTableId	Returns the object ID of the LinetypeTable of this database object.
	getMaterialDictionaryId	Returns the object ID of the Material dictionary of this database object.
	getMLeaderStyleDictionaryId	Returns the object ID of the MLeaderStyle dictionary of this database object.
	getMLStyleDictionaryId	Returns the object ID of the MLineStyle dictionary of this database object.
	getModelSpaceId	Returns the object ID of the ModelSpace Block object of this database object.
	getNamedObjectsDictionaryId	Returns the object ID of the NamedObjects dictionary of this database object.
	getNearestLineWeight	Requires a lineweight and returns the nearest OdDb::LineWeight enum number for this database. For example, when the passed value is 8, the returned value is kLnWt009.
	getOdDbObjectId	Returns the object ID corresponding to the specified handle object in this database.
	getPaperSpaceId	Returns the object ID of the PaperSpace Block object of this database object.
	getPlotSettingsDictionaryId	Returns the object ID of the PlotSettings dictionary of this database object.
	getPlotStyleNameDictionaryId	Returns the object ID of the PlotStyleName dictionary of this database object.
	getPointCloudDictionaryId	Returns the object ID of the point cloud dictionary.
	getPUCSBASEORG	Returns the UCS origin and orthographic view type for the current PaperSpace UCS.
	getRegAppAcadId	Returns the object ID of the "ACAD" RegApp object of this database object.
	getRegAppTableId	Returns the object ID of the RegAppTable of this database object.
	getScaleListDictionaryId	Returns the object ID of the ScaleList dictionary of this database object.
	getSectionManager	Returns the object ID of the section manager.
	getSectionViewStyleDictionaryId	Returns the object ID of the SectionViewStyle dictionary of this database object.
	getSysVar	Returns the specified system variable of this database object.
	getTableStyleDictionaryId	Returns the object ID of the TableStyle dictionary of this database object.
	getTDCREATE	Returns the TDCREATE system variable of this database object.
	getTDUPDATE	Returns the TDUPDATE system variable of this database object.
	getTextStyleStandardId	Returns the object ID of the "Standard" text style object of this database object.
	getTextStyleTableId	Returns the object ID of the TextStyleTable of this database object.
	getUCSBASEORG	Returns the UCS origin and orthographic view type for the current UCS.
	getUCSTableId	Returns the object ID of the UCSTable of this database object.
	getUNDOMARKS	Returns the quantity of undo markers.
	getViewportTableId	Returns the object ID of the ViewportTable of this database object.
	getViewTableId	Returns the object ID of the ViewTable of this database object.
	getVisualStyleDictionaryId	Returns the object ID of the VisualStyle dictionary of this database object.
	globalMaterialId	Returns the identifier of the global material for this database.
	handseed	Returns the next available handle number of this database object.
	hasRedo	Returns true if redo information exists for this database object.
	hasUndo	Returns true if undo information exists for this database object.
	hasUndoMark	Returns whether an undo marker has been set on this database object (returns true) or not (returns false).
	indexingMode	returns OdDb::IndexingModeFlags combination
	initialize	Adds the default set of objects and settings to this database object.
	insert	This is the overview for the insert method overload.
	isDatabaseConverting	Returns true if and only if this database object is being converted after loading from a file or before saving to a file.
	isDatabaseLoading	Returns true if and only if this database object is being loaded from a file.
	isEMR	Returns true if and only if this database object was created by an educational version of the application.
	isMultiThreadedMode	ODA_MT_DB_BEGIN details If multi-threaded mode is on, the method returns true. In the other case it returns false.
	isPartiallyOpened	Returns true if and only if this database object is partially opened.
	isPerObjectConverting	Returns true if per object converting mode is used for this database object.
	isUndoBlockStarted	Returns whether undo history recording has been blocked (returns true) or not (returns false).
	isValidLineWeight	Requires a lineweight and returns True if the specified lineweight is valid, that is, one of the predefined lineweights in this database, or False otherwise.
	lastSavedAsVersion	Returns the version to which this database object was last saved.
	loadLineTypeFile	Loads a linetype into this database object.
	mleaderstyle	Returns the object ID of the current MLeaderStyle of this database object.
	multiThreadedMode	Returns which multi-threaded mode the database currently uses.
	newRegApp	Adds the specified name to the APPID table of this database object.
	numActiveTransactions	Returns the number of active transactions associated with this database object.
	numberOfSaves	Returns the number of times this database object has been saved since it was opened.
	objectContextManager	Returns the OdDbObjectContextManager object of this database object.
	ODRX_DECLARE_MEMBERS	This is ODRX_DECLARE_MEMBERS, a member of class OdDbDatabase.
	originalFilename	Returns the name of the file this database object was loaded from. Can return empty string in case database was created from scratch.
	originalFileSavedByVersion	Returns the version of the application that created the file from which this database object was read.
	originalFileType	Returns the filetype of the file from which this database object was read.
	originalFileVersion	Returns the version of the file from which this database object was read.
	pageObjects	Pages the database objects that have been marked for paging since the last call to this function.
	purge	This is the overview for the purge method overload.
	readFile	This is the overview for the readFile method overload.
	redo	Performs a redo operation on this database object.
	release	Decrements the reference count of this object.
	removeReactor	Removes the specified reactor from this object's reactor list.
	removeTransactionReactor	Removes the specified transaction reactor from this database object.
	renameLayout	Renames the specified layout in this database object.
	resetTimes	Resets TDCREATE, TDUPDATE, TDINDWG and TDUSRTIMER system variables to the settings of the new drawing.
	restoreForwardingXrefSymbols	Returns the database to its modified state (before any original state restoration) by redoing modifications.
	restoreOriginalXrefSymbols	Returns the database to its original state (when the xref was first read) by undoing any modifications.
	retainOriginalThumbnailBitmap	Returns the state of the RetainOriginalThumbnailBitmap flag.
	save	This is the overview for the save method overload.
	sectionViewStyle	Returns the object ID of the current SectionViewStyle of this database object.
	securityParams	Returns the security parameters of this database object.
	setCannoscale	Sets a new annotation scale as a context object for this database.
	setCurrentLayout	This is the overview for the setCurrentLayout method overload.
	setCurrentUCS	This is the overview for the setCurrentUCS method overload.
	setDetailViewStyle	Sets the object ID of the current DetailViewStyle of this database object.
	setDimfit	Sets the R14 DIMFIT system variable of this database object.
	setDimstyleData	This is the overview for the setDimstyleData method overload.
	setDimunit	Sets the R14 DIMUNIT system variable of this database object.
	setFilename	Forcibly sets the name of the current file for this database instance.
	setIndexingMode	param nIndexingModeBitFlags[in] OdDb::IndexingModeFlags combination
	setMLeaderstyle	Sets the object ID of the current MLeaderStyle of this database object.
	setMultiThreadedMode	Sets a new multi-threaded mode for the database. param [in] A new value of multi-threaded mode to be set.
	setPUCSBASEORG	Sets the UCS origin and orthographic view type for the current PaperSpace UCS.
	setRetainOriginalThumbnailBitmap	Controls the state of the RetainOriginalThumbnailBitmap flag.
	setSectionViewStyle	Sets the object ID of the current SectionViewStyle of this database object.
	setSecurityParams	Sets the security parameters of this database object.
	setSysVar	Sets the specified system variable of this database object.
	setTablestyle	Sets the object ID of the current TableStyle of this database object.
	setThumbnailBitmap	Sets the thumbnail bitmap associated with this database object.
	setUCSBASEORG	Sets the UCS origin and orthographic view type for the current UCS.
	setUndoMark	Sets an undo marker on this database object.
	startTransaction	Starts a new transaction of this database object.
	startUndoRecord	Starts undo recording of this database object.
	subGetClassID	Returns the GUID of the database class.
	subWblockClone	As implemented, this function does nothing but return a null SmartPointer. It will be fully implemented in a future release.
	tablestyle	Returns the object ID of the current TableStyle of this database object.
	thumbnailBitmap	Returns the thumbnail bitmap associated with this database object.
	undo	Performs an undo operation on this database object.
	undoBack	Performs the undo operation on this database object.
	undoFiler	Returns the current object used for udo file input/output operations.
	updateExt	Recalculates the extents of this database object.
	usingCoreOnly	Returns the true if OdDbDatabase instance is restricted to use only core objects. In such mode implementation of OdDbDatabase::initialize() for example will not create some objects like dimension style table and default dimension style or default multi-line style. Default implementation simply returns 'false'
	version	Returns the version of this database object.
	wblock	This is the overview for the wblock method overload.
	wblockCloneObjects	Shallow clones a set of objects and appends the clones to the specified owner object.
	writeFile	This is the overview for the writeFile method overload.
	xrefBlockId	Returns the object ID of the OdDbBlockTableRecord that references this database object as an Xref.

Send feedback about this topic