OdBmElement Class

Class Hierarchy

Syntax

C++

class OdBmElement : public OdBmObject;

File

BmElement.h

Description

This is a base class for BimRv elements.

Group

Database Classes

OdBmElement Methods

addCell	Adds a cell to the element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
addParam	Adds a parameter to an element.
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.
database	Returns database associated with this element as a pointer to the OdBmDatabase object.
finishEditMode	Disable edit mode for element.
getAbFlags4Bytes	Calls the getAbFlags4Bytes method of the related OdBmElementHeader.
getAssemblyInstanceId	Returns the Id of the assembly to which the element belongs.
getAssocLevelId	Returns the AssocLevelId of this element.
getBaseDesignOptionId	Returns the Id of Design Option which was read from a file.
getBBox	Calls the getElemHeaderBBox method of the related OdBmElementHeader.
getCellList	Returns the cell list of this element.
getClassDef	Calls the getClassDef method of the related OdBmElementHeader.
getConstrInfo	Fetches constraint info and writes to the passed argument.
getCreatedPhaseId	Returns the created phase id of this element.
getDatabase	Returns the database of this element.
getDemolishedPhaseId	Returns the demolished phase id of this element.
getDesignOptionId	Returns the Id of Design Option.
getDoubleParams	Returns the DoubleParams of this element.
getDummy	Checks if this is a dummy element.
getDynamicObject	Returns a dynamic object, that represents data for elements of types that are not supported by the latest file format.
getElementName	Returns the element name as OdString value.
getElemRec	Returns the ElemRec of this element.
getESEntities	Returns all entities in the element.
getESEntity	Returns the entity in the element by specified GUID.
getExtraFillingAttributes	Sets up element extra filling attributes if required. Returns true in this case and false otherwise
getFamId	Returns the family id of this element.
getFamilyName	Returns the family name as OdString value.
getFilterElement
getFilterElement
getGeometry	Returns the geometry part of this element.
getGeometry	Returns the part of geometry which passes the element settings.
getGeomExtents	Returns geometry extents of this element as an object of OdGeExtents3d class.
getGeomSteps	Updates geometry if it's required and returns geometry step list.
getGeomTable	Updated geometry if required and returns the geometry table of this element.
getGroupId	Retreives the Group to which the element belongs.
getGsMarkersAtSubentPath	Returns all graphic system marker by subentity paths for complex entities, that has the ability to associate an integer identifier (GS marker) with each graphic primitive or with groups of primitives during draw themself.
getHeader	Returns the header part of this element.
getHeaderCategoryId	Calls the getHeaderCategoryId method of the related OdBmElementHeader.
getHistory	Calls the getHistory method of the related OdBmElemRec.
getIntParams	Returns the IntParams of this element.
getLocked	Checks if this element is locked.
getMaterialArea	Returns the area of the material with the specified id.
getMaterialIds	Retrives the ids of all materials of the element.
getMaterialVolume	Returns the volume of the material with the specified id.
getMiscId	Calls the getMiscId method of the related OdBmElementHeader.
getMoribund	Checks if this element is moribund.
getObjectIdParams	Returns the ObjectIdParams of this element.
getOwnerDBViewId	Returns the owner database view id of this element.
getOwningElementId	Calls the getOwningElementId method of the related OdBmElemRec. remarks Throws eNotHandled if this element is null.
getParam	Retrieves a parameter value from an element.
getParam	Retrieves a parameter value from an element.
getParam	Retrieves a parameter value from an element.
getParam	Retrieves a parameter value from an element.
getParam	Retrieves a parameter value from an element.
getParam	Retrieves a parameter value from an element using given parameter id.
getParam	Retrieves a parameter value from an element using given parameter id.
getParam	Retrieves a parameter value from an element using given parameter id.
getParam	Retrieves a parameter value from an element using given parameter id.
getParam	Retrieves a parameter value from an element using given parameter id.
getParamValueAsString	Retrieves a string representation of built in parameter from an element.
getParamValueAsString	Retrieves a string representation of parameter value from an element.
getParents	Calls the getParents method of the related OdBmElementHeader.
getPartitionId	Calls the getPartitionId method of the related OdBmElemRec.
getProperty	Retrieves the object's property value.
getProperty	Retrieves the object's property value.
getProperty	Retrieves the object's property value.
getRegenHistory	Calls the getRegenHistory method of the related OdBmElementHeader.
getShortDescriptiveName	Returns the descriptive element name as OdString value.
getStringParams	Returns the StringParams of this element.
getSubentPathsAtGsMarker
getTypeID	Returns the element type id if available.
getTypeName	Returns the element's type name as OdString value.
getUniqueId	Returns the unique identifier for the element from the database.
getUnplacedOwnerId	Returns the unplaced owner id of this element.
getVersionGuid	Returns the unique identifier for the element from the database.
getViewRules	Calls the getViewRules method of the related OdBmElementHeader.
getWorksetId	Returns the Id of the Workset which owns the element.
hasDesignPropManager	Checks if the element has DesignPropertyManager.
highlight	Highlights or unhighlights the specified path.
isClippable	Returns true if this element could be clipped
isDBRO	Returns true if and only this object is a database -resident object.
isEditMode	Retrieves whether the Edit mode is enabled for the database.
isInAFamily	Returns true if and only if this element is a part of a family.
isNewObject	Returns true if and only if this object has not been closed since it was created.
isSectionable	Returns true if this element could be sectioned
isVisibleInView	Checks if this element is visible on the specified view.
objectId	Returns database objects's id
ownerId	Returns the ID of the element's owner as an OdBmObjectId object.
owningElemId	Returns the ID of the element's owning element as an OdBmObjectId object.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
popParam	Pops a parameter with given id from an element.
runEditMode	Retrieves edit manager for element and set element to edit mode.
setAbFlags4Bytes	Calls the setAbFlags4Bytes method of the related OdBmElementHeader.
setAssocLevelId	Sets the AssocLevelId for this element.
setBaseDesignOptionId	Sets the Id of Base Design Option.
setBBox	Calls the setBBox method of the related OdBmElementHeader.
setCellList	Sets the cell list for this element.
setClassDef	Calls the setClassDef method of the related OdBmElementHeader.
setConstrInfo	Sets constraint info for this element.
setCreatedPhaseId	Sets the created phase id for this element.
setDatabase	Sets the database for this element.
setDemolishedPhaseId	Sets the demolished phase id for this element.
setDoubleParams	Sets the DoubleParams for this element.
setDummy	Sets a value to the dummy flag of this element.
setESEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
setFamId	Sets the family id for this element.
setGeomSteps	Sets the geometry step list for this element.
setGeomTable	Sets the geometry table for this element.
setHistory	Calls the setHistory method of the related OdBmElemRec.
setIntParams	Sets the IntParams for this element.
setLocked	Sets a value to the locked flag of this element.
setMiscId	Calls the setMiscId method of the related OdBmElementHeader.
setMoribund	Sets a value to the moribund flag of this element.
setObjectIdParams	Sets the ObjectIdParams for this element.
setOwnerDBViewId	Sets the owner database view id for this element.
setOwningElementId	Calls the setOwningElementId method of the related OdBmElemRec.
setParam	Sets a value to a parameter.
setParam	Sets a value to a parameter.
setParam	Sets a value to a parameter.
setParam	Sets a value to a parameter.
setParam	Sets a value to a parameter.
setParam	Sets a value to a parameter by it's id.
setParam	Sets a value to a parameter by it's id.
setParam	Sets a value to a parameter by it's id.
setParam	Sets a value to a parameter by it's id.
setParam	Sets a value to a parameter by it's id.
setParents	Calls the setParents method of the related OdBmElementHeader.
setPartitionId	Calls the setPartitionId method of the related OdBmElemRec.
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.
setRegenHistory	Calls the setRegenHistory method of the related OdBmElementHeader.
setStringParams	Sets the StringParams for this element.
setUnplacedOwnerId	Sets the unplaced owner id for this element.
setViewRules	Calls the setViewRules method of the related OdBmElementHeader.
subHighlight	The method is used to highlight an element.
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
transformBy	Transform element with given matrix.

Send feedback about this topic