/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // This file is generated automatically. #ifndef _IFC2X3_IFCOPENINGELEMENT_AUTO_IMPL_H #define _IFC2X3_IFCOPENINGELEMENT_AUTO_IMPL_H #include "IfcFeatureElementSubtractionAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X3 express schema definitions. */ namespace OdIfc2x3 { /** \details 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: The next image shows an opening with recess extrusion: 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. - 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. */ class IFC2X3_EXPORT IfcOpeningElement : public IfcFeatureElementSubtraction { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcOpeningElement); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details 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. \param HasFillings [out] Receives the value of HasFillings attribute. */ void getInvHasFillings(OdDAIObjectIds& HasFillings) const; public: /** \details Reads object's data from the specified filer. \param 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. */ virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override; /** \details Writes object's data the the specified filer. \param 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. */ virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override; /** \details Returns a type of a class instance. \returns Pointer to the OdDAI::Entity type that determines an entity definition within a schema. */ virtual OdDAI::Entity* getInstanceType() const override; /** \details Early-bound version of instances comparison. \param pOther [in] Other application instance. \param ordering [out] Receives the ordering (comparison) status. \returns true if comparison was performed, false if method has no implementation, so late-bound version could be applied. \remarks If the method returns true, the ordering parameter can receive one of the following statuses: Name Value Description _kLessThan_ -1 This object < Other Object. _kEqual_ 0 This object = Other Object. _kGreaterThan_ 1 This object > Other Object. _kNotOrderable_ 2 This class is not orderable.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override; /** \details Resets a value for the specified attribute. \param explicitAttrName [in] Explicit name of the attribute to reset. */ virtual void unsetAttr(const char * explicitAttrName) override; /** \details Checks whether the specified attribute is set. \param explicitAttrName [in] Explicit name of the attribute to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const char * explicitAttrName) const override; /** \details Checks whether the specified instance is the object derived from or belongs to this class. \param entityType [in] Entity to check. \returns true if the specified instance is the object derived from or belongs to this class, false otherwise. */ virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override; /** \details Returns the type of this entity. \returns A value of the OdIfc::OdIfcEntityType type that represents type of this entity. */ virtual OdIfc::OdIfcEntityType type() const override; /** \details Returns an attribute value for the specified attribute definition. \param attrDef [in] Attribute definition to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override; /** \details Resets a value for the specified attribute. \param explicitAttrDef [in] Explicit definition that represents an attribute to reset. */ virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override; /** \details Checks whether the specified attribute is set. \param explicitAttrDef [in] Attribute definition to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrDef [in] Explicit attribute definition to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override; protected: using IfcElement::getAttr; using IfcElement::putAttr; protected: // Declare friend classes for inverse attributes functionality: friend class IfcRelFillsElement; }; /** \details A data type that represents a smart pointer to a IfcOpeningElement object. */ typedef OdSmartPtr IfcOpeningElementPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X3_IFCOPENINGELEMENT_AUTO_IMPL_H