/////////////////////////////////////////////////////////////////////////////// // 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 _IFC2X_FINAL_IFCSTAIR_AUTO_IMPL_H #define _IFC2X_FINAL_IFCSTAIR_AUTO_IMPL_H #include "IfcBuildingElementAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X_FINAL express schema definitions. */ namespace OdIfc2x_final { /** \details A stair is a vertical passageway allowing occupants to walk (step) from one floor level to another floor level at a different elevation. It can include a landing as an intermediate floor slab. The IfcStair can either be represented: * as a stair assembly entity that aggregates all parts (stair flight, landing, etc. with own representations) * as a single stair entity without decomposition including all representation directly at the stair entity * NOTE: In case of an IfcStair being the aggregate of all parts of the stair the aggregation is handled by the IfcRelAggregates relationship, relating an IfcStair with the related IfcStairFlight and landings, IfcSlab with PredefinedType=LANDING. IfcRailing's belonging to the stair can also be included into the aggregation. - Axis 2D Geometry - The walking line is represented by a two-dimensional open curve as the axis. The curve is directed into the upward direction (direction has to be interpreted as specified at the subtypes of IfcCurve). - Element Decomposition - The image below illustrates stair placement, where the IfcStair defines the local placement for all components and the common 'Axis' representation, and each component has its own 'Body' representation. This concept can be applied to the following resources: * IfcStairFlight - Stairs can be decomposed into stair flights * IfcSlab - Stairs can be decomposed into stair landing, represented by IfcSlab.PredefinedType=LANDING * IfcRailing - Stairs can be decomposed into railings for zero, one, or both sides - Material Single - The material of the IfcStair is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be specified at the IfcStairType, defining the common attribute data for all occurrences of the same type. It is then accessible by the inverse IsDefinedBy relationship pointing to IfcStair.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are specified, then the material directly assigned to IfcStair overrides the material assigned to IfcStairType. - Object Typing - This concept can be applied to the following resources: * IfcStairType - Product Local Placement - The following restriction can be imposed by view definitions or implementer agreements: * If the IfcStair establishes an aggregate, then all contained elements are placed relative to the IfcStair.ObjectPlacement. - Property Sets for Objects - This concept can be applied to the following resources: * Pset_ConcreteElementGeneral * Pset_PrecastConcreteElementFabrication * Pset_PrecastConcreteElementGeneral * Pset_StairCommon - Spatial Containment - The IfcStair, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships: * the Spatial Containment (defined here) * the Element Composition */ class IFC2X_FINAL_EXPORT IfcStair : public IfcBuildingElement { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcStair); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of ShapeType attribute. This attribute represents predefined shape types for a stair that are specified in an enumeration. \returns Returns the value of ShapeType attribute. \remarks * IFC4 CHANGE: The attribute has been renamed to PredefinedType and changed to be OPTIONAL with upward compatibility for file-based exchange */ IfcStairTypeEnum getShapeType() const; /** \details Sets the value of ShapeType attribute. This attribute represents predefined shape types for a stair that are specified in an enumeration. \param ShapeType [in] Shape type to set. \remarks * IFC4 CHANGE: The attribute has been renamed to PredefinedType and changed to be OPTIONAL with upward compatibility for file-based exchange */ void setShapeType(IfcStairTypeEnum ShapeType); public: /** \details Default constructor for the IfcStair class. */ IfcStair(); /** \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_ShapeType; // IfcStairTypeEnum }; /** \details A data type that represents a smart pointer to a IfcStair object. */ typedef OdSmartPtr IfcStairPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X_FINAL_IFCSTAIR_AUTO_IMPL_H