CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcBuildingElement Class Reference

#include <IfcBuildingElementAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcBuildingElement:
OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance OdIfc2x_final::IfcBeam OdIfc2x_final::IfcBuildingElementProxy OdIfc2x_final::IfcColumn OdIfc2x_final::IfcCovering OdIfc2x_final::IfcCurtainWall OdIfc2x_final::IfcDoor OdIfc2x_final::IfcRailing OdIfc2x_final::IfcRamp OdIfc2x_final::IfcRampFlight OdIfc2x_final::IfcRoof OdIfc2x_final::IfcSlab OdIfc2x_final::IfcStair OdIfc2x_final::IfcStairFlight OdIfc2x_final::IfcWall OdIfc2x_final::IfcWindow

Public Member Functions

void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc2x_final::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID getGlobalId () const
 
void setGlobalId (OdDAI::CompressedGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Member Functions

virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Friends

class IfcRelSpaceBoundary
 
class IfcRelVoidsElement
 
class IfcRelFillsElement
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 
- Protected Attributes inherited from OdIfc2x_final::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc2x_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Detailed Description

The building element comprises all elements that are primarily part of the construction of a building, i.e., its structural and space separating system. They are separated from other elements, since they are dealt with in separate AEC processes. The IfcBuildingElement utilizes the following capabilities mainly through inverse referenced to objectified relationships: Grouping - being part of a logical group of objects Classification - assigned reference to an external classification Documentation - assigned reference to an external documentation Type - reference to the product type information for the element occurrence Properties - reference to all attached properties, including quantities Cost control - reference to cost elements associated with this building element Work processes - reference to work tasks, in which this building element is used Aggregation - aggregated together with other elements to form an aggregate Connection - connectivity to other elements, including the definition of the joint Ports - information, whether the building element has ports for system connections Realization - information, whether the building element is used to realize a connection Assignment to spatial structure - hierarchical assignment to the right level within the spatial structure Material - assignment of material used by this building element Boundary - provision of space boundaries through this building element Opening - information, whether the building element includes openings Projection - information, whether the building element has projections Filling - information whether the building element is used to fill openings

  • Quantity Use Definition - The quantities relating to the IfcBuildingElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties. A detailed specification for individual quantities is introduced at the level of subtypes of IfcBuildingElement.
  • Geometry Use Definitions - The geometric representation of any IfcBuildingElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations.
  • Local Placement - The local placement for any IfcBuildingElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. Further constraints are defined at the level of its subtypes.
  • Bounding Box Representation - Any IfcBuildingElement can be represented as a bounding box, which shows the maximum extend of the body within the coordinated system established by the IfcLocalPlacement. The bounding box representation is the simplest geometric representation available. The following attribute values for the IfcShapeRepresentation holding this geometric representation is used: RepresentationIdentifier : 'Body' RepresentationType : 'BoundingBox'

The bounding box representation is given by an IfcShapeRepresentation, which includes a single item, an IfcBoundingBox.

<IMAGE ifcbuildingelement_1>

  • SurfaceModel Representation - Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) can be represented as a single or multiple surface models, based on either shell or face based models. The following attribute values for the IfcShapeRepresentation holding this geometric representation is used: RepresentationIdentifier : 'Body' RepresentationType : 'SurfaceModel'

In some cases it can be useful to also expose a simple representation as a bounding box representation of the same complex shape. The surface model representation is given by an IfcShapeRepresentation, which includes a single item, which is either: IfcShellBasedSurfaceModel IfcFaceBasedSurfaceModel

<IMAGE ifcbuildingelement_2>

  • Brep Representation - Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) can be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation is used: RepresentationIdentifier : 'Body' RepresentationType : 'Brep'

In some cases it can be useful to also expose a simple representation as a bounding box representation of the same complex shape. TheBrep representation is given by an IfcShapeRepresentation, which includes one or more items, all of type IfcManifoldSolidBrep.

<IMAGE ifcbuildingelement_3>

  • MappedRepresentation - Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) can be represented using the MappedRepresentation. This is supported as it allows for reusing the geometry definition of a type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used: RepresentationIdentifier : 'Body' RepresentationType : 'MappedRepresentation'

Definition at line 116 of file Ifc2x_Final/IfcBuildingElementAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcElement::getAttr ( const char * attrName) const
overrideprotectedvirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcBuildingElement::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcBuildingElement::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBeam, OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcColumn, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcCurtainWall, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRampFlight, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, OdIfc2x_final::IfcWall, OdIfc2x_final::IfcWallStandardCase, and OdIfc2x_final::IfcWindow.

◆ getInvFillsVoids()

void OdIfc2x_final::IfcBuildingElement::getInvFillsVoids ( OdDAIObjectIds & FillsVoids) const

Returns the value of MountingType attribute. This attribute represents reference to the Fills Relationship that puts the Element into the Opening within another Element.

Returns
Returns the value of MountingType attribute.

◆ getInvHasOpenings()

void OdIfc2x_final::IfcBuildingElement::getInvHasOpenings ( OdDAIObjectIds & HasOpenings) const

Returns the value of MountingType attribute. This attribute represents reference to the Voids Relationship that creates an opening in an element. An element can incorporate zero-to-many openings.

Returns
Returns the value of MountingType attribute.

◆ getInvProvidesBoundaries()

void OdIfc2x_final::IfcBuildingElement::getInvProvidesBoundaries ( OdDAIObjectIds & ProvidesBoundaries) const

Returns the value of MountingType attribute. This attribute represents reference to Space Boundaries by virtue of the objectified relationship IfcRelSeparatesSpaces. It defines the concept of an Building Element bounding Spaces.

Returns
Returns the value of MountingType attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcBuildingElement::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcBuildingElement::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBeam, OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcColumn, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcCurtainWall, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRampFlight, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, OdIfc2x_final::IfcWall, OdIfc2x_final::IfcWallStandardCase, and OdIfc2x_final::IfcWindow.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcBuildingElement::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcElement::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overrideprotectedvirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcBuildingElement::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcBuildingElement::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcBuildingElement::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcBuildingElement::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcBuildingElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcBuildingElement::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcBuildingElementProxy, OdIfc2x_final::IfcCovering, OdIfc2x_final::IfcDoor, OdIfc2x_final::IfcRailing, OdIfc2x_final::IfcRamp, OdIfc2x_final::IfcRoof, OdIfc2x_final::IfcSlab, OdIfc2x_final::IfcStair, OdIfc2x_final::IfcStairFlight, and OdIfc2x_final::IfcWindow.

Friends And Related Symbol Documentation

◆ IfcRelFillsElement

friend class IfcRelFillsElement
friend

Definition at line 253 of file Ifc2x_Final/IfcBuildingElementAutoImpl.h.

◆ IfcRelSpaceBoundary

friend class IfcRelSpaceBoundary
friend

Definition at line 251 of file Ifc2x_Final/IfcBuildingElementAutoImpl.h.

◆ IfcRelVoidsElement

friend class IfcRelVoidsElement
friend

Definition at line 252 of file Ifc2x_Final/IfcBuildingElementAutoImpl.h.


The documentation for this class was generated from the following file: