OdBmFamily Class

Class Hierarchy

Syntax

C++

class OdBmFamily : public OdBmFamilyBase;

File

BmFamily.h

Description

This is the base class for family classes.

Group

Family 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.

OdBmElement Class

	Name	Description
	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.
	getAbFlags4Bytes	This is getAbFlags4Bytes, a member of class OdBmElement.
	getAssemblyInstanceId	Returns the Id of the assembly to which the element belongs.
	getAssocLevelId	This is getAssocLevelId, a member of class OdBmElement.
	getBaseDesignOptionId	Returns the Id of Design Option which was read from a file.
	getBBox	This is getBBox, a member of class OdBmElement.
	getCellList	This is getCellList, a member of class OdBmElement.
	getClassDef	This is getClassDef, a member of class OdBmElement.
	getConstrInfo	This is getConstrInfo, a member of class OdBmElement.
	getCreatedPhaseId	This is getCreatedPhaseId, a member of class OdBmElement.
	getDatabase	This is getDatabase, a member of class OdBmElement.
	getDemolishedPhaseId	This is getDemolishedPhaseId, a member of class OdBmElement.
	getDesignOptionId	Returns the Id of Design Option.
	getDoubleParams	This is getDoubleParams, a member of class OdBmElement.
	getDummy	This is getDummy, a member of class OdBmElement.
	getDynamicObject	This is getDynamicObject, a member of class OdBmElement.
	getElementName	Returns the element name as OdString value.
	getElemRec	This is getElemRec, a member of class OdBmElement.
	getESEntities	Returns all entities in the element.
	getESEntity	Returns the entity in the element by specified GUID.
	getFamId	This is getFamId, a member of class OdBmElement.
	getFamilyName	Returns the family name as OdString value.
	getFilterElement	This is getFilterElement, a member of class OdBmElement.
	getFilterElement	This is getFilterElement, a member of class OdBmElement.
	getGeometry	This is getGeometry, a member of class OdBmElement.
	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	This is getGeomSteps, a member of class OdBmElement.
	getGeomTable	This is getGeomTable, a member of class OdBmElement.
	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	This is getHeader, a member of class OdBmElement.
	getHeaderCategoryId	Returns the Id of Category taken from Header.
	getHistory	This is getHistory, a member of class OdBmElement.
	getIntParams	This is getIntParams, a member of class OdBmElement.
	getLocked	This is getLocked, a member of class OdBmElement.
	getMiscId	This is getMiscId, a member of class OdBmElement.
	getMoribund	This is getMoribund, a member of class OdBmElement.
	getObjectIdParams	This is getObjectIdParams, a member of class OdBmElement.
	getOwnerDBViewId	This is getOwnerDBViewId, a member of class OdBmElement.
	getOwningElementId	This is getOwningElementId, a member of class OdBmElement.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParents	This is getParents, a member of class OdBmElement.
	getPartitionId	This is getPartitionId, a member of class OdBmElement.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getRegenHistory	This is getRegenHistory, a member of class OdBmElement.
	getShortDescriptiveName	Returns the descriptive element name as OdString value.
	getStringParams	This is getStringParams, a member of class OdBmElement.
	getSubentPathsAtGsMarker	This is getSubentPathsAtGsMarker, a member of class OdBmElement.
	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	This is getUnplacedOwnerId, a member of class OdBmElement.
	getViewRules	This is getViewRules, a member of class OdBmElement.
	getWorksetId	Returns the Id of the Workset which owns the element.
	hasDesignPropManager	Checks if the element has DesignPropertyManager.
	highlight	This is highlight, a member of class OdBmElement.
	isAnnotation	Returns true if this element has a 'Annotation' category type.
	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.
	setAbFlags4Bytes	This is setAbFlags4Bytes, a member of class OdBmElement.
	setAssocLevelId	This is setAssocLevelId, a member of class OdBmElement.
	setBaseDesignOptionId	Sets the Id of Base Design Option.
	setBBox	This is setBBox, a member of class OdBmElement.
	setCellList	This is setCellList, a member of class OdBmElement.
	setClassDef	This is setClassDef, a member of class OdBmElement.
	setConstrInfo	This is setConstrInfo, a member of class OdBmElement.
	setCreatedPhaseId	This is setCreatedPhaseId, a member of class OdBmElement.
	setDatabase	This is setDatabase, a member of class OdBmElement.
	setDemolishedPhaseId	This is setDemolishedPhaseId, a member of class OdBmElement.
	setDoubleParams	This is setDoubleParams, a member of class OdBmElement.
	setDummy	This is setDummy, a member of class OdBmElement.
	setEditMode	Change EdimMode state for the element.
	setESEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
	setFamId	This is setFamId, a member of class OdBmElement.
	setGeomSteps	This is setGeomSteps, a member of class OdBmElement.
	setGeomTable	This is setGeomTable, a member of class OdBmElement.
	setHistory	This is setHistory, a member of class OdBmElement.
	setIntParams	This is setIntParams, a member of class OdBmElement.
	setLocked	This is setLocked, a member of class OdBmElement.
	setMiscId	This is setMiscId, a member of class OdBmElement.
	setMoribund	This is setMoribund, a member of class OdBmElement.
	setObjectIdParams	This is setObjectIdParams, a member of class OdBmElement.
	setOwnerDBViewId	This is setOwnerDBViewId, a member of class OdBmElement.
	setOwningElementId	This is setOwningElementId, a member of class OdBmElement.
	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	This is setParents, a member of class OdBmElement.
	setPartitionId	This is setPartitionId, a member of class OdBmElement.
	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	This is setRegenHistory, a member of class OdBmElement.
	setStringParams	This is setStringParams, a member of class OdBmElement.
	setUnplacedOwnerId	This is setUnplacedOwnerId, a member of class OdBmElement.
	setViewRules	This is setViewRules, a member of class OdBmElement.
	subHighlight	The method is used to highlight an element.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.

OdBmFamilyBase Class

	Name	Description
	getAllowCutWithUnattachedVoids	Retrieves whether the family allows to cut with unattached voids.
	getAppVersionAtInitialLoad	Retrieves the current application version at initial loading.
	getAppVersionAtLoad	Retrieves the current application version at loading.
	getBeamCutbackForColumn	Retrieves the current beam cutback for a column.
	getBraceRepType	Retrieves the current brace representation type.
	getCanHostRebar	Retrieves whether the family can host rebar.
	getContentProtected	Retrieves whether the family's content is protected.
	getCouldAutojoin	Retrieves whether a data can be auto-join to the family.
	getCurveBased	Retrieves whether the family is curve based.
	getCutback	Retrieves whether the family is a cutback.
	getDatabase2	Retrieves a BimRv database object associated with the family.
	getDBViewInfos	Retrieves the array of DB Views.
	getDeletableElements	Retrieves the identifiers of deletable elements for the family.
	getDumpSymName	Retrieves the dump symbolic name.
	getElecKeepAnnotationOrientation	Retrieves whether the family maintains annotation orientation.
	getElevationMarkBody	Retrieves whether the family uses elevation mark.
	getEnableCuttingInViews	Retrieves whether the family enables cutting in views.
	getFamilyCatalogKeysItem	This is getFamilyCatalogKeysItem, a member of class OdBmFamilyBase.
	getFamilyCategoryId	Retrieves the identifier of the current family category.
	getFamilyDocGUID	Retrieves the family documentation global unique identifier (GUID).
	getFamilyDocument	Retrieves family's document.
	getFamilyIds	Retrieves the set of the family identifiers.
	getFamilyNameKeyText	Retrieves the text of the family name key.
	getFamilyParams	Retrieves the current parameters of the family.
	getFamilyTypes	Retrieves the family types.
	getForceProperMirroring	Retrieves whether the family is forsed to proper mirroring.
	getFromADPx	Retrieves whether the family is from ADPX or not.
	getFsDos	Retrieves FsDos.
	getHasBaseArrays	Retrieves whether the family has base arrays
	getHasComplexCuts	Retrieves whether the family has complex cuts.
	getHasInstances	Retrieves whether the family has instances
	getHasLabeledDimensions	Retrieves whether the family has labeled dimensions.
	getHasRoomCalculationPoint	Retrieves whether the family has room calculation point
	getHasSimpleCuts	Retrieves whether the family has simple cuts.
	getHasTypesFromCatalog	Retrieves whether the family has types form the catalog.
	getHostFaceGeomRef	Retrieves the reference to the face geometry of the family's host.
	getInPlace	Retrieves whether the family is an in-place family or is a loadable one.
	getIs2d	Retrieves whether the family is a 2d-family.
	getIsAboutToBecomeParametric	Retrieves whether the family is about to become a parametric family.
	getIsAdHoc	Retrieves whether the family is an AdHoc.
	getIsCrvDriven	Retrieves whether the family is a curve driven family.
	getIsCurtainPanel	Retrieves whether the family is a curtain panel family.
	getIsHostBased	Retrieves whether the family is host based
	getIsModel	Retrieves whether the family is a model family.
	getIsNew2010	Retrieves whether the family family has 2010 format.
	getIsParametric	Retrieves whether the family has parametric relations between its components.
	getIsRebarShape	Retrieves whether the family contains rebar shape type.
	getIsSavable	Retrieves whether the family is a savable family.
	getIsSelfOrienting	Retrieves whether the family is self-oriented.
	getIsShared	Retrieves whether the family is shared
	getIsSpiralShape	Retrieves whether the family is a spiral shape.
	getIsVertical	Retrieves whether the family is vertical or horizontal.
	getIsWorkPlaneBased	Retrieves whether the family is work plane based
	getKeepTextReadable	Retrieves whether the family text should be kept readable.
	getKeyExtParamId	Retrieves the identifier of the family filter parameter.
	getLightSourceDefBits	Retrieves the current light source definition bits.
	getLockedParameterIdsForDirectManipulation	Retrieves the array that contains identifiers of the locked parameters for direct manipulation.
	getName	Retrieves the family name.
	getNextAbsorbedIndex	Retrieves the next absorbed index for the family.
	getOldCurveElemsWithBadSketchAndSP	Retrieves the array that contains identifiers of the old curves with bad sketches.
	getOmniClassCode	Retrieves the omniclass number.
	getOwnerSymbolId	Retrieves the owner symbol identifier.
	getPanelConfig	Retrieves the current panel configuration for the family.
	getPartType	Retrieves the current part type of the family.
	getPath	Retrieves the current path to the family.
	getPredefinedLimitIdx	Retrieves the current predefined limit for the family.
	getProfileFamDefinition	Retrieves the current profile families definition.
	getProfileFamUsage	Retrieves the current profile families.
	getProtectionAccessKey	Retrieves the current projection access key.
	getProteinRenderType	Retrieves the current protein render type.
	getRegeneratingGroupId	Retrieves the identifier of the regeneration group.
	getRenderModelType	Retrieves the current rendering model type for the family.
	getRotateTagTextWithComponent	This is getRotateTagTextWithComponent, a member of class OdBmFamilyBase.
	getRotateTagWithComponent	Retrieves whether the family's tag is rotated with a component.
	getRoundConnDimType	Retrieves the current round connector dimension type.
	getSeekItemId	Retrieves the identifier of the seek item.
	getShouldStayParametric	Retrieves whether the family should stay a parametric family.
	getStretchingDisallowed	Retrieves whether the family disallows stretching.
	getStructConnectionApplyTo	Retrieves the connection on which the family should be connected to.
	getStructHiddenViewDisplayType	Retrieves the current display type of a hidden view.
	getStructuralCodeName	Retrieves the current structural code name of the family.
	getStructuralMaterialType	Retrieves the current physical material type of the family.
	getStructUseCap	Retrieves whether the family is using cap.
	getSymbolicRepType	Retrieves the current symbolic representation type of the family.
	getTagCurveAttachmentProportion	Retrieves the current curve attachment point tag.
	getTrivialParamIds	Retrieves the array of trivial parameter identifiers for the family.
	getUsePreCutShape	Retrieves whether the family shows pre-cut in plan view
	isRegistred	Checks whether a specified identifier is registered in the family.
	registerId	Registers a specified identifier in the family.
	setAppVersionAtInitialLoad	Sets a new application version at initial loading.
	setAppVersionAtLoad	Sets a new application version at loading.
	setBeamCutbackForColumn	Sets a new beam cutback for a column.
	setBraceRepType	Sets a new value of the brace representation type.
	setDatabase2	Associates a specified BimRv database with the family.
	setDBViewInfos	Sets a new array of DB Views for the family.
	setDumpSymName	Sets a new dump symbolic name.
	setElevationMarkBody	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).
	setEnableCuttingInViews	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.
	setFamilyCategoryId	Sets a new family category identifier.
	setFamilyDocGUID	Sets a new family documentation global unique identifier (GUID).
	setFamilyIds	Sets a new set of family identifiers.
	setFamilyParams	Sets new family parameters.
	setFamilyTypes	Sets a new family type table.
	setInPlace	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).
	setIsModel	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).
	setIsParametric	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).
	setLightSourceDefBits	Sets new light source definition bits.
	setName	Sets a new family name.
	setNextAbsorbedIndex	Sets the next absorbed index for the family.
	setOwnerSymbolId	Sets a new owner symbol Id.
	setPanelConfig	Sets a new panel configuration value.
	setPartType	Sets a new part type of the family.
	setPath	Sets a new family path.
	setPredefinedLimitIdx	Sets a new predefined limit value for the family.
	setProfileFamDefinition	Sets a new profile families definition.
	setProfileFamUsage	Sets new profile families.
	setProteinRenderType	Sets a new protein render type value.
	setRenderModelType	Sets a new rendering model type for the family.
	setRoundConnDimType	Sets a new round connector dimension type.
	setStructConnectionApplyTo	Sets the connection on which the family should be connected to.
	setStructHiddenViewDisplayType	Sets a new display type of a hidden view.
	setStructuralMaterialType	Sets a new physical material type value for the family.
	setSymbolicRepType	Sets a new symbolic representation type for the family.
	setTagCurveAttachmentProportion	Sets a new curve attachment point tag.
	setUsePreCutShape	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.

OdBmFamily Class

	Name	Description
	getBHasAnyDummyRefs	This is getBHasAnyDummyRefs, a member of class OdBmFamily.
	getDefaultColumnHeight	Retrieves default column height for the family.
	getDefaultHeightAboveLevel	Retrieves default height for above level.
	getDefaultHostThickness	Retrieves default host thickness for the family.
	getDefaultStretchLine	Retrieves the default stretch line for the family.
	getElevationFixed	Retrieves whether the elevation value is fixed for the family.
	getFamDimConstrMgr	This is getFamDimConstrMgr, a member of class OdBmFamily.
	getFamilyReferenceIdxMgr	This is getFamilyReferenceIdxMgr, a member of class OdBmFamily.
	getFixedElevation	Retrieves the current value of the fixed elevation for the family.
	getHostType	Retrieves the family's host type.
	getInplaceFamElevation	Retrieves the current elevation value for in-place family.
	getIsUserCreated	Retrieves whether the family was created by a user.
	getOutOfFamilyHostGrefs	This is getOutOfFamilyHostGrefs, a member of class OdBmFamily.
	getOutOfFamilyHostIds	This is getOutOfFamilyHostIds, a member of class OdBmFamily.
	getOutOfFamilyRefs	This is getOutOfFamilyRefs, a member of class OdBmFamily.
	getReferences	Retrieves references from the family.
	getReferenceTypeIds	Retrieves identifiers of reference types.
	getSetCreated2011FaceBasedFamily	This is getSetCreated2011FaceBasedFamily, a member of class OdBmFamily.
	getSurrogateId	Retrieves the identifier of the family surrogate.
	isStandalone	Retrieves whether the family is standalone.
	mayHaveFreeHost	Retrieves whether the family may have a free host.
	setElevationFixed	Sets a new value of the fixed elevation flag that determines whether the elevation value is fixed for the family (if it is equal to true); otherwise, the flag is equal to false.
	setFamDimConstrMgr	This is setFamDimConstrMgr, a member of class OdBmFamily.
	setFixedElevation	Sets a new value of the fixed elevation.
	setInplaceFamElevation	Sets a new value of the elevation for in-place family.
	setIsUserCreated	Sets a new value of the user creation flag. This flag determines whether the family was created by a user (flag value is equal to true) or not (flag value is equal to false).
	setOutOfFamilyRefs	This is setOutOfFamilyRefs, a member of class OdBmFamily.
	setReferences	Sets a new array of references for the family.
	setReferenceTypeIds	Sets a new array of reference type identifiers for the family.
	setSetCreated2011FaceBasedFamily	This is setSetCreated2011FaceBasedFamily, a member of class OdBmFamily.
	setSurrogateId	Sets a new identifier for the family's surrogate.

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