/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X3_ADD2_IFCSPATIALSTRUCTUREELEMENT_AUTO_IMPL_H #define _IFC4X3_ADD2_IFCSPATIALSTRUCTUREELEMENT_AUTO_IMPL_H #include "IfcSpatialElementAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X3_ADD2 express schema definitions. */ namespace OdIfc4x3_add2 { /** \details A spatial structure element is the generalization of all spatial elements that can be used to define a spatial structure. That spatial structure tipically provides a project structure to organize a building project. A spatial project structure can define as many levels of decomposition as necessary for the building project. Elements within the spatial project structure are: * site as IfcSite * facility as IfcFacility, or specifically * building as IfcBuilding * bridge as IfcBridge * marine facility as IfcMarineFacility * railway as IfcRailway * road as IfcRoad * facility part as IfcFacilityPart, or specifically * storey as IfcBuildingStorey * facility part as IfcFacilityPart * space as IfcSpace Also elements can be aggregations or parts of items from the list above. The composition type declares an element to be either an element itself, or an aggregation (complex) or a decomposition (part). The interpretation of these types is specified at each subtype of IfcSpatialStructureElement. The image below shows the use of IfcRelAggregates to establish a spatial structure including site, building, building section and storey. \remarks This definition may not be instantiated. */ class IFC4X3_EXPORT IfcSpatialStructureElement : public IfcSpatialElement { //DOM-IGNORE-BEGIN OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcSpatialStructureElement); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of CompositionType attribute. This attribute indicates whether the predefined spatial structure element represents itself, or an aggregate (complex) or a part (part). The interpretation is specified separately for each subtype of spatial structure element. If no CompositionType is asserted, the dafault value 'ELEMENT' applies. \returns Returns the value of CompositionType attribute. \remarks IFC4 CHANGE: Attribute made optional. */ IfcElementCompositionEnum getCompositionType() const; /** \details Sets the value of CompositionType attribute. This attribute indicates whether the predefined spatial structure element represents itself, or an aggregate (complex) or a part (part). The interpretation is specified separately for each subtype of spatial structure element. If no CompositionType is asserted, the dafault value 'ELEMENT' applies. \param CompositionType [in] Composition type to set. \remarks IFC4 CHANGE: Attribute made optional. */ void setCompositionType(IfcElementCompositionEnum CompositionType); public: /** \details Default constructor for the IfcSpatialStructureElement class. */ IfcSpatialStructureElement(); /** \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 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::Enum m_CompositionType; // IfcElementCompositionEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcSpatialStructureElement object. */ typedef OdSmartPtr IfcSpatialStructureElementPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X3_ADD2_IFCSPATIALSTRUCTUREELEMENT_AUTO_IMPL_H