/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X2_IFCRELREFERENCEDINSPATIALSTRUCTURE_AUTO_IMPL_H #define _IFC4X2_IFCRELREFERENCEDINSPATIALSTRUCTURE_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 IFC4X2 express schema definitions. */ namespace OdIfc4x2 { /** \details The objectified relationship, IfcRelReferencedInSpatialStructure is used to assign elements in addition to those levels of the project spatial structure, in which they are referenced, but not primarily contained. It is also used to connect a system to the relevant spatial element that it serves. * NOTE: The primary containment relationship between an element and the spatial structure is handled by IfcRelContainedInSpatialStructure. - Details - Any element can be referenced to zero, one or several levels of the spatial structure. Whereas the IfcRelContainedInSpatialStructure relationship is required to be hierarchical (an element can only be contained in exactly one spatial structure element), the IfcRelReferencedInSpatialStructure is not restricted to be hierarchical. * EXAMPLE: A wall might be normally contained within a storey, and since it does not span through several stories, it is not referenced in any additional storey. However a curtain wall might span through several stories, in this case it can be contained within the ground floor, but it would be referenced by all additional stories, it spans. Predefined spatial structure elements to which elements can be assigned are: * site as IfcSite * facility as IfcFacility or its subtypes IfcBridge, IfcBuilding, IfcMarineFacility, IfcRailway or IfcRoad * part of facility as IfcFaciltityPart, or more specifically as IfcBuildingStorey or IfcSpace The following picture shows the use of IfcRelContainedInSpatialStructure and IfcRelReferencedInSpatialStructure to assign an IfcCurtainWall to two different levels within the spatial structure. It is primarily contained within the ground floor, and additionally referenced within the first and second floor. \changes * IFC4 changes: Type of the RelatingStructure attribute changed from IfcSpatialStructureElement to IfcSpatialElement. */ class IFC4X2_EXPORT IfcRelReferencedInSpatialStructure : public IfcRelConnects { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcRelReferencedInSpatialStructure); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Gets the value of RelatedElements attribute. This attribute represents a set of products, which are referenced within this level of the spatial structure hierarchy. \param RelatedElements [out] Receives the RelatedElements attribute. */ void getRelatedElements(OdDAIObjectIds& RelatedElements) const; /** \details Returns the value of RelatedElements attribute. This attribute represents a set of products, which are referenced within this level of the spatial structure hierarchy. \returns Returns the value of RelatedElements attribute. */ OdDAI::SetOfOdDAIObjectId& relatedElements(); /** \details Returns the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is referenced. Any element can be contained within zero, one or many elements of the project spatial structure. \returns Returns the value of RelatingStructure attribute. */ const OdDAIObjectId& getRelatingStructure() const; /** \details Sets the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is referenced. Any element can be contained within zero, one or many elements of the project spatial structure. \param RelatingStructure [in] RelatingStructure to set. */ 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 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 IfcRelReferencedInSpatialStructure object. */ typedef OdSmartPtr IfcRelReferencedInSpatialStructurePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCRELREFERENCEDINSPATIALSTRUCTURE_AUTO_IMPL_H