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

#include <IfcOpeningElementAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcOpeningElement:
OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

OdDAIObjectId getInvVoidsElements () const
 
void getInvHasFillings (OdDAIObjectIds &HasFillings) 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 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 opening element stands for opening, recess or chase, all reflecting voids. It represents a void within any element that has physical manifestation. Openings can be inserted into walls, slabs, beams, columns, or other elements. There are two different types of opening elements. The attribute PredefinedType should be used to capture the differences: an opening, where the thickness of the opening is greater or equal to the thickness of the element — the attribute PredefinedType is set to OPENING a recess or niche, where the thickness of the recess is smaller than the thickness of the element — the attribute PredefinedType is set to RECESS for a recess or niche.

If the value for PredefinedType is omitted, or the value is set to NOTDEFINED, no specific information of whether it is an opening or recess shall be assumed.

An IfcOpeningElement has to be inserted into an IfcElement by using the IfcRelVoidsElement relationship. It can be filled by an IfcDoor, IfcWindow, or another filling element by using the relationship IfcRelFillsElements. Depending on the type of the IfcShapeRepresentation of the IfcOpeningElement the voiding relationship implies: if the IfcShapeRepresentation.RepresentationIdentifier = 'Body', then the Body shape representation of the opening has to be subtracted from the body shape representation of the voided element - implicit Boolean difference operation. if the IfcShapeRepresentation.RepresentationIdentifier = 'Reference', then the Reference shape representation of the opening is not subtracted, it is provided in addition to the hole in the Body shape representation of the voided element.

The IfcOpeningElement does not participate in the containment relationship, i.e. it is not linked directly to the spatial structure of the project. It has a mandatory VoidsElements inverse relationship pointing to the IfcElement that is contained in the spatial structure. The inverse relationship ContainedInStructure should be NIL.

  • Body SweptSolid Geometry - The 'Body' representation of IfcOpeningElement can be represented using the representation types 'SweptSolid'. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used: IfcShapeRepresentation.RepresentationIdentifier: 'Body' IfcShapeRepresentation.RepresentationType: 'SweptSolid'

The following constraints are recommended: IfcShapeRepresentation.Items can include a single, or multiple, instances of IfcExtrudedAreaSolid. IfcExtrudedAreaSolid.SweptArea supports IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef. If multiple instances of IfcExtrudedAreaSolid are used, the extrusion direction of each extrusion should be equal.

If parametric profiles are used, the parameters can be interpreted to be the dimensions of the beam: IfcRectangleProfileDef.YDim interpreted as beam height IfcRectangleProfileDef.XDim interpreted as beam width There are two main extrusion directions: perpendicular and parallel.

For a perpendicular swept solid, IfcExtrudedAreaSolid.ExtrudedDirection extrudes the profile perpendicular to the element it is voiding. This can be horizontal for wall openings, or vertical for floor openings. The next image shows an opening with full extrusion:

<IMAGE ifcopeningelement_horizontal-layout1>

The next image shows an opening with recess extrusion:

<IMAGE ifcopeningelement_recess-layout1>

For a parallel swept solid,IfcExtrudedAreaSolid.ExtrudedDirection extrudes the profile parallel to the element it is voiding. This can be vertical in the case of walls. The image below shows a vertical extrusion with multiple extrusion bodies for the opening. Each extrusion body has a different extrusion length.

<IMAGE ifcopeningelement_vertical-layout1>

  • Product Local Placement - The local placement for IfcOpeningElement 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. The PlacementRelTo relationship of IfcLocalPlacement should point to the local placement of the element which is voided by the opening, i.e. referred to by VoidsElement.RelatingBuildingElement.
  • Property Sets for Objects - This concept can be applied to the following resources: Pset_OpeningElementCommon
  • Quantity Sets - This concept can be applied to the following resources: Qto_OpeningElementBaseQuantities
  • Reference Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.
  • Reference SweptSolid PolyCurve Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.
  • Reference Tessellation Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.
Remarks
The entity IfcOpeningStandardCase has been deleted. Use an IfcOpeningElement with a single extrusion body perpendicular to the wall or slab instead.

Definition at line 123 of file Ifc2x_Final/IfcOpeningElementAutoImpl.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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcOpeningElement::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.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcOpeningElement::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.

◆ getInvHasFillings()

void OdIfc2x_final::IfcOpeningElement::getInvHasFillings ( OdDAIObjectIds & HasFillings) const

Returns the value of HasFillings attribute. This attribute represents reference to the Filling Relationship that is used to assign Elements as Fillings for this Opening Element. The Opening Element can be filled with zero-to-many Elements.

Parameters
HasFillings[out] Receives the value of HasFillings attribute.

◆ getInvVoidsElements()

OdDAIObjectId OdIfc2x_final::IfcOpeningElement::getInvVoidsElements ( ) const

Returns the value of VoidsElements attribute. This attribute represents reference to the Voids Relationship that uses this Opening Element to create a void within an Element. The Opening Element can only be used to create a single void within a single Element.

Parameters
VoidsElements[out] Receives the value of VoidsElements attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcOpeningElement::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.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcOpeningElement::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.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcOpeningElement::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.

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

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcOpeningElement::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.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcOpeningElement::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.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcOpeningElement::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.

◆ type()

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

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc2x_final::IfcElement.

◆ unsetAttr() [1/2]

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

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc2x_final::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcOpeningElement::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.

Friends And Related Symbol Documentation

◆ IfcRelFillsElement

friend class IfcRelFillsElement
friend

Definition at line 248 of file Ifc2x_Final/IfcOpeningElementAutoImpl.h.

◆ IfcRelVoidsElement

friend class IfcRelVoidsElement
friend

Definition at line 247 of file Ifc2x_Final/IfcOpeningElementAutoImpl.h.


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