API Reference > Classes > Database Classes > OdBmFamilyBase Class
OdBmFamilyBase Class
OdBmFamilyBaseOdBmFamilyBaseOdBmFamilyBaseOdBmFamilyBase
Syntax
C++
class OdBmFamilyBase : public OdBmElement;

BmFamilyBase.h

This is the base class for family classes. 

 

OdBmObject Class
 
Name 
Description 
 
A destructor for the BimRv object. 
 
Name 
Description 
 
Adds a new persistent reactor object to the element's reactor list.  
 
Adds a new transient reactor object to the element's reactor list.  
 
Retrieves the object's owner object.  
 
Retrieves all the persistent reactors from the element.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves all the transient reactors from the element.  
 
Retrieves whether a specified persistent reactor object is attached to the element.  
 
Removes a specified persistent reactor object from the element's reactor list.  
 
Removes a specified transient reactor object from the element's reactor list.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
OdBmObject Class
 
Name 
Description 
 
Adds a new persistent reactor object to the element's reactor list.  
 
Adds a new transient reactor object to the element's reactor list.  
 
Increments the counter of references to the object. 
 
Clones the object.
 
 
Retrieves the related database object.
 
 
Retrieves the drawable type of the object.
 
 
Returns a WCS bounding box that represents the extents of this object.
 
 
Retrieves the list of built-in parameters.
 
 
Retrieves the object's owner object.  
 
Retrieves all the persistent reactors from the element.  
 
Retrieves the array of object's properties.
 
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves all the transient reactors from the element.  
 
Retrieves graphical system cache associated with the object.
 
 
Retrieves whether a specified persistent reactor object is attached to the element.  
 
id 
Retrieves the object's identifier in the associated database.
 
 
Retrieves whether the object is persistent or not.
 
 
Retrieves the current quantity of references to the object.
 
 
Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed. 
 
Removes a specified persistent reactor object from the element's reactor list.  
 
Removes a specified transient reactor object from the element's reactor list.  
 
Applies the default properties of the specified database to this entity.
 
 
Assigns the specified OdGsCache to this object.
 
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Retrieves the current regeneration support flags set for the object.
 
 
Sets the vectorization attributes of the object, and returns its attribute flags.
 
 
Called by setDatabaseDefaults() after the values are set.
 
 
Implements viewport-dependent rendering.
 
 
Implements the mechanism for rendering the object.
 
OdBmElement Class
 
Name 
Description 
 
Adds a cell to the element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Throws an exception if this object is not open OdDb::kForNotify. 
 
Throws an exception if this object is not open OdDb::kForRead. 
 
Throws an exception if this object is not open OdDb::kForWrite, and controls automatic *undo* and notification of modifications. 
 
Returns database associated with this element as a pointer to the OdBmDatabase object. 
 
This is getAbFlags4Bytes, a member of class OdBmElement. 
 
Returns the Id of the assembly to which the element belongs. 
 
This is getAssocLevelId, a member of class OdBmElement. 
 
Returns the Id of Design Option which was read from a file. 
 
This is getBBox, a member of class OdBmElement. 
 
This is getCellList, a member of class OdBmElement. 
 
This is getClassDef, a member of class OdBmElement. 
 
This is getConstrInfo, a member of class OdBmElement. 
 
This is getCreatedPhaseId, a member of class OdBmElement. 
 
This is getDatabase, a member of class OdBmElement. 
 
This is getDemolishedPhaseId, a member of class OdBmElement. 
 
Returns the Id of Design Option. 
 
This is getDoubleParams, a member of class OdBmElement. 
 
This is getDummy, a member of class OdBmElement. 
 
This is getDynamicObject, a member of class OdBmElement. 
 
Returns the element name as OdString value. 
 
This is getElemRec, a member of class OdBmElement. 
 
Returns all entities in the element. 
 
Returns the entity in the element by specified GUID.
 
 
This is getFamId, a member of class OdBmElement. 
 
Returns the family name as OdString value. 
 
This is getFilterElement, a member of class OdBmElement. 
 
This is getFilterElement, a member of class OdBmElement. 
 
This is getGeometry, a member of class OdBmElement. 
 
Returns the part of geometry which passes the element settings.
 
 
Returns geometry extents of this element as an object of OdGeExtents3d class.
 
 
This is getGeomSteps, a member of class OdBmElement. 
 
This is getGeomTable, a member of class OdBmElement. 
 
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.
 
 
This is getHeader, a member of class OdBmElement. 
 
Returns the Id of Category taken from Header. 
 
This is getHistory, a member of class OdBmElement. 
 
This is getIntParams, a member of class OdBmElement. 
 
This is getLocked, a member of class OdBmElement. 
 
This is getMiscId, a member of class OdBmElement. 
 
This is getMoribund, a member of class OdBmElement. 
 
This is getObjectIdParams, a member of class OdBmElement. 
 
This is getOwnerDBViewId, a member of class OdBmElement. 
 
This is getOwningElementId, a member of class OdBmElement. 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
This is getParents, a member of class OdBmElement. 
 
This is getPartitionId, a member of class OdBmElement. 
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
This is getRegenHistory, a member of class OdBmElement. 
 
Returns the descriptive element name as OdString value. 
 
This is getStringParams, a member of class OdBmElement. 
 
This is getSubentPathsAtGsMarker, a member of class OdBmElement. 
 
Returns the element type id if available. 
 
Returns the element's type name as OdString value. 
 
Returns the unique identifier for the element from the database. 
 
This is getUnplacedOwnerId, a member of class OdBmElement. 
 
This is getViewRules, a member of class OdBmElement. 
 
Returns the Id of the Workset which owns the element. 
 
Checks if the element has DesignPropertyManager.  
 
This is highlight, a member of class OdBmElement. 
 
Returns true if this element has a 'Annotation' category type. 
 
Returns true if this element could be clipped
 
 
Returns true if and only this object is a *database* -resident object. 
 
Retrieves whether the Edit mode is enabled for the database.  
 
Returns true if and only if this element is a part of a family. 
 
Returns true if and only if this object has not been *closed* since it was created. 
 
Returns true if this element could be sectioned 
 
Checks if this element is visible on the specified view.
 
 
Returns database objects's id 
 
Returns the ID of the element's owner as an OdBmObjectId object. 
 
Returns the ID of the element's owning element as an OdBmObjectId object. 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
This is setAbFlags4Bytes, a member of class OdBmElement. 
 
This is setAssocLevelId, a member of class OdBmElement. 
 
Sets the Id of Base Design Option.
 
 
This is setBBox, a member of class OdBmElement. 
 
This is setCellList, a member of class OdBmElement. 
 
This is setClassDef, a member of class OdBmElement. 
 
This is setConstrInfo, a member of class OdBmElement. 
 
This is setCreatedPhaseId, a member of class OdBmElement. 
 
This is setDatabase, a member of class OdBmElement. 
 
This is setDemolishedPhaseId, a member of class OdBmElement. 
 
This is setDoubleParams, a member of class OdBmElement. 
 
This is setDummy, a member of class OdBmElement. 
 
Change EdimMode state for the element.
 
 
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
 
 
This is setFamId, a member of class OdBmElement. 
 
This is setGeomSteps, a member of class OdBmElement. 
 
This is setGeomTable, a member of class OdBmElement. 
 
This is setHistory, a member of class OdBmElement. 
 
This is setIntParams, a member of class OdBmElement. 
 
This is setLocked, a member of class OdBmElement. 
 
This is setMiscId, a member of class OdBmElement. 
 
This is setMoribund, a member of class OdBmElement. 
 
This is setObjectIdParams, a member of class OdBmElement. 
 
This is setOwnerDBViewId, a member of class OdBmElement. 
 
This is setOwningElementId, a member of class OdBmElement. 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
This is setParents, a member of class OdBmElement. 
 
This is setPartitionId, a member of class OdBmElement. 
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
This is setRegenHistory, a member of class OdBmElement. 
 
This is setStringParams, a member of class OdBmElement. 
 
This is setUnplacedOwnerId, a member of class OdBmElement. 
 
This is setViewRules, a member of class OdBmElement. 
 
The method is used to highlight an element. 
 
Called by setDatabaseDefaults() after the values are set.
 
OdBmFamilyBase Class
 
Name 
Description 
 
Retrieves whether the family allows to cut with unattached voids.  
 
Retrieves the current application version at initial loading.  
 
Retrieves the current application version at loading.  
 
Retrieves the current beam cutback for a column.  
 
Retrieves the current brace representation type.  
 
Retrieves whether the family can host rebar.  
 
Retrieves whether the family's content is protected.  
 
Retrieves whether a data can be auto-join to the family.  
 
Retrieves whether the family is curve based.  
 
Retrieves whether the family is a cutback.  
 
Retrieves a BimRv database object associated with the family.  
 
Retrieves the array of DB Views.  
 
Retrieves the identifiers of deletable elements for the family.  
 
Retrieves the dump symbolic name.  
 
Retrieves whether the family maintains annotation orientation.  
 
Retrieves whether the family uses elevation mark.  
 
Retrieves whether the family enables cutting in views.  
 
This is getFamilyCatalogKeysItem, a member of class OdBmFamilyBase. 
 
Retrieves the identifier of the current family category.  
 
Retrieves the family documentation global unique identifier (GUID).  
 
Retrieves family's document.  
 
Retrieves the set of the family identifiers.  
 
Retrieves the text of the family name key.  
 
Retrieves the current parameters of the family.  
 
Retrieves the family types.  
 
Retrieves whether the family is forsed to proper mirroring.  
 
Retrieves whether the family is from ADPX or not.  
 
Retrieves FsDos.  
 
Retrieves whether the family has base arrays  
 
Retrieves whether the family has complex cuts.  
 
Retrieves whether the family has instances  
 
Retrieves whether the family has labeled dimensions.  
 
Retrieves whether the family has room calculation point  
 
Retrieves whether the family has simple cuts.  
 
Retrieves whether the family has types form the catalog.  
 
Retrieves the reference to the face geometry of the family's host.  
 
Retrieves whether the family is an in-place family or is a loadable one.  
 
Retrieves whether the family is a 2d-family.  
 
Retrieves whether the family is about to become a parametric family.  
 
Retrieves whether the family is an AdHoc.  
 
Retrieves whether the family is a curve driven family.  
 
Retrieves whether the family is a curtain panel family.  
 
Retrieves whether the family is host based  
 
Retrieves whether the family is a model family.  
 
Retrieves whether the family family has 2010 format.  
 
Retrieves whether the family has parametric relations between its components.  
 
Retrieves whether the family contains rebar shape type.  
 
Retrieves whether the family is a savable family.  
 
Retrieves whether the family is self-oriented.  
 
Retrieves whether the family is shared  
 
Retrieves whether the family is a spiral shape.  
 
Retrieves whether the family is vertical or horizontal.  
 
Retrieves whether the family is work plane based  
 
Retrieves whether the family text should be kept readable.  
 
Retrieves the identifier of the family filter parameter.  
 
Retrieves the current light source definition bits.  
 
Retrieves the array that contains identifiers of the locked parameters for direct manipulation.  
 
Retrieves the family name.  
 
Retrieves the next absorbed index for the family.  
 
Retrieves the array that contains identifiers of the old curves with bad sketches.  
 
Retrieves the omniclass number.  
 
Retrieves the owner symbol identifier.  
 
Retrieves the current panel configuration for the family.  
 
Retrieves the current part type of the family.  
 
Retrieves the current path to the family.  
 
Retrieves the current predefined limit for the family.  
 
Retrieves the current profile families definition.  
 
Retrieves the current profile families.  
 
Retrieves the current projection access key.  
 
Retrieves the current protein render type.  
 
Retrieves the identifier of the regeneration group.  
 
Retrieves the current rendering model type for the family.  
 
This is getRotateTagTextWithComponent, a member of class OdBmFamilyBase. 
 
Retrieves whether the family's tag is rotated with a component.  
 
Retrieves the current round connector dimension type.  
 
Retrieves the identifier of the seek item.  
 
Retrieves whether the family should stay a parametric family.  
 
Retrieves whether the family disallows stretching.  
 
Retrieves the connection on which the family should be connected to.  
 
Retrieves the current display type of a hidden view.  
 
Retrieves the current structural code name of the family.  
 
Retrieves the current physical material type of the family.  
 
Retrieves whether the family is using cap.  
 
Retrieves the current symbolic representation type of the family.  
 
Retrieves the current curve attachment point tag.  
 
Retrieves the array of trivial parameter identifiers for the family.  
 
Retrieves whether the family shows pre-cut in plan view  
 
Checks whether a specified identifier is registered in the family.  
 
Registers a specified identifier in the family.  
 
Sets a new application version at initial loading.  
 
Sets a new application version at loading.  
 
Sets a new beam cutback for a column.  
 
Sets a new value of the brace representation type.  
 
Associates a specified BimRv database with the family.  
 
Sets a new array of DB Views for the family.  
 
Sets a new dump symbolic name.  
 
Sets a new value of the elevation mark flag. This flag determines whether the family uses an elevation mark (if is equal to true) or not (if is equal to false).  
 
Sets a new value of the cutting in views flag. This flag determines whether cutting views are enabled (if is equal to true) or not (if is equal to false) for the family.  
 
Sets a new family category identifier.  
 
Sets a new family documentation global unique identifier (GUID).  
 
Sets a new set of family identifiers.  
 
Sets new family parameters.  
 
Sets a new family type table.  
 
Sets new value of the in-place flag. In-place flag determines whether the family is an in-place family (if it is equal to true) or not (if it is equal to false).  
 
Sets new value of the model flag. The model flag determines whether the family is a model family (if it is equal to true) or not (if it is equal to false).  
 
Sets a new value of the parametric relations flag. This flag determines whether the family has parametric relations between its components (if is equal to true) or not (if is equal to false).  
 
Sets new light source definition bits.  
 
Sets a new family name.  
 
Sets the next absorbed index for the family.  
 
Sets a new owner symbol Id.  
 
Sets a new panel configuration value.  
 
Sets a new part type of the family.  
 
Sets a new family path.  
 
Sets a new predefined limit value for the family.  
 
Sets a new profile families definition.  
 
Sets new profile families.  
 
Sets a new protein render type value.  
 
Sets a new rendering model type for the family.  
 
Sets a new round connector dimension type.  
 
Sets the connection on which the family should be connected to.  
 
Sets a new display type of a hidden view.  
 
Sets a new physical material type value for the family.  
 
Sets a new symbolic representation type for the family.  
 
Sets a new curve attachment point tag.  
 
Sets new value of the flag which controls whether the family shows pre-cut in plan view. If the flag value is equal to true, the family shows pre-cut in plan view; otherwise, if the flag is equal to false, the family does not.  
OdBmObject Class
Name 
Description 
This is nested type OdBmObject::ItemIndexType. 
This is nested type OdBmObject::PropertyIndexType. 
Copyright (c) 2002-2020. Open Design Alliance. All rights reserved.