/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X4_IFCRELCONTAINEDINSPATIALSTRUCTURE_AUTO_IMPL_H #define _IFC4X4_IFCRELCONTAINEDINSPATIALSTRUCTURE_AUTO_IMPL_H #include "IfcRelConnectsAutoImpl.h" #include "IfcSpatialElementAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X4 express schema definitions. */ namespace OdIfc4x4 { /** \details This objectified relationship is used to assign elements to a certain level of the spatial project structure. Any element can only be assigned once to a certain level of the spatial structure. The question, which level is relevant for which type of element, can only be answered within the context of a particular project and might vary within the various regions. * EXAMPLE: A multi-storey space is contained (or belongs to) the building storey at which its ground level is, but it is referenced by all the other building storeys, in which it spans. A lift shaft might be contained by the basement, but referenced by all storeys, through which it spans. The containment relationship of an element within a spatial structure has to be a hierarchical relationship; an element can only be contained within a single spatial structure element. The reference relationship between an element and the spatial structure need not be hierarchical; that is, an element can reference many spatial structure elements. Predefined spatial structure elements to which elements can be assigned are * site as IfcSite * building as IfcBuilding * storey as IfcBuildingStorey * space as IfcSpace Occurrences of the same element type can be assigned to different spatial structure elements depending on the context of the occurrence. * EXAMPLE: A wall might be normally assigned to a storey, however the curtain wall might be assigned to the building and the retaining wall in the terrain might be assigned to the site. - Example - The next picture shows the use of IfcRelContainedInSpatialStructure to assign a stair and two walls to two different levels within the spatial structure. \remarks The reference relationship is expressed by IfcRelReferencedInSpatialStructure. \changes * IFC2X_FINAL changes: The data type of the attribute RelatedElements has been changed from IfcElement to its supertype IfcProduct with upward compatibility for file-based exchange. * IFC4 changes: Type of the RelatingStructure attribute type changed from IfcSpatialStructureElement to IfcSpatialElement. */ class IFC4X4_EXPORT IfcRelContainedInSpatialStructure : public IfcRelConnects { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcRelContainedInSpatialStructure); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of RelatedElements attribute. This attribute represents set of products which are contained within this level of the spatial structure hierarchy. \param RelatedElements [out] Receives the related elements. \remarks IFC2x CHANGE: The data type has been changed from IfcElement to IfcProduct with upward compatibility. */ void getRelatedElements(OdDAIObjectIds& RelatedElements) const; /** \details Returns the value of RelatedElements attribute. This attribute represents set of products which are contained within this level of the spatial structure hierarchy. \returns Returns the value of RelatedElements attribute. \remarks IFC2x CHANGE: The data type has been changed from IfcElement to IfcProduct with upward compatibility. */ OdDAI::SetOfOdDAIObjectId& relatedElements(); /** \details Returns the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is contained. Any element can only be contained within one element of the project spatial structure. \returns Returns the value of RelatingStructure attribute. \remarks IFC4 CHANGE: The attribute RelatingStructure as been promoted to the new supertype IfcSpatialElement with upward compatibility for file based exchange. */ const OdDAIObjectId& getRelatingStructure() const; /** \details Sets the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is contained. Any element can only be contained within one element of the project spatial structure. \param RelatingStructure [in] Relating structure to set. \remarks IFC4 CHANGE: The attribute RelatingStructure as been promoted to the new supertype IfcSpatialElement with upward compatibility for file based exchange. */ void setRelatingStructure(const OdDAIObjectId& RelatingStructure); 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 Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes. */ virtual void setInverseCounterParts() 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 Returns an attribute value for the specified attribute name. \param attrName [in] Name of an attribute to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const char * attrName) 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 Sets the specified attribute with a given value. \param explicitAttrName [in] Explicit name of the attribute 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 char * explicitAttrName, const OdRxValue &val) 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: // Fields declaration: OdDAI::SetOfOdDAIObjectId m_RelatedElements; // SET [1:?] of IfcProduct OdDAIObjectId m_RelatingStructure; // IfcSpatialElement }; /** \details A data type that represents a smart pointer to a IfcRelContainedInSpatialStructure object. */ typedef OdSmartPtr IfcRelContainedInSpatialStructurePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X4_IFCRELCONTAINEDINSPATIALSTRUCTURE_AUTO_IMPL_H