/////////////////////////////////////////////////////////////////////////////// // 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_IFCSPACE_AUTO_IMPL_H #define _IFC4X2_IFCSPACE_AUTO_IMPL_H #include "IfcSpatialStructureElementAutoImpl.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 A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building. A space is associated to a building storey (or in case of exterior spaces to a site). A space can span over several connected spaces. Therefore a space group provides for a collection of spaces included in a storey. A space can also be decomposed in parts, where each part defines a partial space. This is defined by the CompositionType attribute of the supertype IfcSpatialStructureElement which is interpreted as follow: * COMPLEX = space group * ELEMENT = space * PARTIAL = partial space The image below shows the IfcSpace as part of the spatial structure. It also serves as the spatial container for space related elements. The next image describes the heights and elevations of the IfcSpace. * Elevation of the space (top of construction slab) equals elevation of storey: provided by IfcBuildingStorey.Elevation relative to IfcBuilding.ElevationOfRefHeight * Elevation of the space flooring (top of flooring on top of slab): provided by IfcSpace.ElevationWithFlooring relative to IfcBuilding.ElevationOfRefHeight * Height of space (top of slab below to bottom of slab above): provided by BaseQuantity with Name="Height" * Floor height of space (top of slab below to top of flooring): provided by BaseQuantity with Name="FinishFloorHeight" * Net height of space (top of flooring to bottom of suspended ceiling): provided by BaseQuantity with Name="FinishCeilingHeight" - FootPrint GeomSet Geometry - The following constraints apply to the 2D representation: * An IfcBoundedCurve is required, using IfcPolyline for faceted space contours or IfcCompositeCurve for space contours with arc segments. For spaces with inner boundaries, a set of IfcBoundedCurve's is used, that should be grouped into an IfcGeometricCurveSet. - Object Typing - This concept can be applied to the following resources: * IfcSpaceType - Product Local Placement - The local placement for IfcSpace is defined at 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 points to the local placement of the IfcSpatialStructureElement of IfcBuildingStorey type or of IfcSite type if relative placement is used. * If the relative placement is not used, the absolute placement is defined within the world coordinate system. - Property Sets for Objects - This concept can be applied to the following resources: * Pset_ProcessCapacity * Pset_BerthCommon (only applies to BERTH) * Pset_FenderDesignCriteria (only applies to BERTH) * Pset_SpaceParking (only applies to PARKING) - Quantity Sets - This concept can be applied to the following resources: * Qto_SpaceBaseQuantities - Spatial Composition - The Spatial Composition concept uses the inverse relationship IfcSpace.IsDecomposedBy to reference IfcSpace by IfcRelAggregates.RelatedObjects. If it refers to another instance of IfcSpace, the referenced IfcSpace needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcSpace has COMPLEX), or PARTIAL (if the other IfcSpace has ELEMENT). This concept can be applied to the following resources: * IfcProject * IfcSite * IfcBuilding * IfcBuildingStorey * IfcSpace * IfcFacility * IfcBridge * IfcMarineFacility * IfcRailway * IfcRoad * IfcFacilityPartCommon * IfcBridgePart * IfcMarinePart * IfcRailwayPart * IfcRoadPart - Spatial Container - If there are building elements and/or other elements directly related to the IfcSpace (like most furniture and distribution elements), they are associated with the IfcSpace by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcSpace references them by its inverse relationship: * IfcSpace.ContainsElements - referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements. - Spatial Decomposition - Spatial Decomposition concept uses the IfcSpace.Decomposes inverse relationship to reference IfcSite, or IfcBuildingStorey, or IfcSpace by IfcRelAggregates.RelatingObject. If it refers to another instance of IfcSpace, the referenced IfcSpace needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcSpace has ELEMENT), or ELEMENT (if the other IfcSpace has PARTIAL). This concept can be applied to the following resources: * IfcSpace */ class IFC4X2_EXPORT IfcSpace : public IfcSpatialStructureElement { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcSpace); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of PredefinedType attribute. This attribute represents predefined generic types for a space that are specified in an enumeration. There can be property sets defined specifically for each predefined type. \returns Returns the value of PredefinedType attribute. \remarks IFC4 CHANGE: The attribute has been renamed from ExteriorOrInteriorSpace with upward compatibility for file-based exchange. */ IfcSpaceTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents predefined generic types for a space that are specified in an enumeration. There can be property sets defined specifically for each predefined type. \param PredefinedType [in] Predefined type to set. \remarks IFC4 CHANGE: The attribute has been renamed from ExteriorOrInteriorSpace with upward compatibility for file-based exchange. */ void setPredefinedType(IfcSpaceTypeEnum PredefinedType); /** \details Returns the value of ElevationWithFlooring attribute. This attribute represents level of flooring of this space; the average is taken, if the space ground surface is sloping or if there are level differences within this space. \returns Returns the value of ElevationWithFlooring attribute. */ double getElevationWithFlooring() const; /** \details Sets the value of ElevationWithFlooring attribute. This attribute represents level of flooring of this space; the average is taken, if the space ground surface is sloping or if there are level differences within this space. \param ElevationWithFlooring [in] Elevation with flooring to set. */ void setElevationWithFlooring(double ElevationWithFlooring); /** \details Returns the value of HasCoverings attribute. This attribute represents reference to IfcCovering by virtue of the objectified relationship IfcRelCoversSpaces. It defines the concept of a space having coverings assigned. Those coverings can represent different flooring, or tiling areas. \param HasCoverings [out] Receives the value of HasCoverings attribute. \remarks Coverings are often managed by the space, and not by the building element, which they cover. */ void getInvHasCoverings(OdDAIObjectIds& HasCoverings) const; /** \details Returns the value of BoundedBy attribute. This attribute represents reference to a set of IfcRelSpaceBoundary's that defines the physical or virtual delimitation of that space against physical or virtual boundaries. \param BoundedBy [out] Receives the value of BoundedBy attribute. */ void getInvBoundedBy(OdDAIObjectIds& BoundedBy) const; public: /** \details Default constructor for the IfcSpace class. */ IfcSpace(); /** \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 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_PredefinedType; // IfcSpaceTypeEnum [optional] double m_ElevationWithFlooring; // IfcLengthMeasure [optional] // Declare friend classes for inverse attributes functionality: friend class IfcRelCoversSpaces; friend class IfcRelSpaceBoundary; }; /** \details A data type that represents a smart pointer to a IfcSpace object. */ typedef OdSmartPtr IfcSpacePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCSPACE_AUTO_IMPL_H