/////////////////////////////////////////////////////////////////////////////// // 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_RC1_IFCSTAIRFLIGHT_AUTO_IMPL_H #define _IFC4X3_RC1_IFCSTAIRFLIGHT_AUTO_IMPL_H #include "IfcBuiltElementAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X3_RC1 express schema definitions. */ namespace OdIfc4x3_rc1 { /** \details A stair flight is an assembly of building components in a single "run" of stair steps (not interrupted by a landing). The stair steps and any stringers are included in the stair flight. A winder is also regarded a part of a stair flight. An IfcStairFlight is normally aggregated by an IfcStair through the IfcRelAggregates relationship, the stair flight is then included in the set of IfcRelAggregates.RelatedObjects. An IfcStairFlight normally connects the floor slab of zero to two different storeys (or partial storeys, or landings) within a building. The connection relationship between the IfcStairFlight and the IfcSlab can be expressed using the IfcRelConnectsElements relationship. - 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). The image below illustrates the axis representation which has the following constraints: * In case of straight flights the curve is a single item of type IfcPolyline * In case of winding flights the curve is a single item of type IfcCompositeCurve * In case of a curved flight or a spiral flight the curve is a single item of type IfcTrimmedCurve - Body SweptSolid Geometry - The image below illustrates the 'Body' geometric representation using a 'SweptSolid' representation type. - FootPrint Geometry - The flight foot print, including the flight boundary is represented by a two-dimensional geometric curve set. The image below illustrates the footprint representation which has the following constraints: * In case of straight flights the curve set consists of a single item of type IfcPolyline * In case of winding flights or curved flights the curve set consists of a single item of type IfcCompositeCurve * In case of a spiral flight the curve set consists of a single item of type IfcConic or IfcPolyline \changes * IFC4 changes: * Name of the NumberOfRiser attribute changed to NumberOfRisers * Type of the NumberOfRiser attribute changed from "integer" to "IfcInteger" * Type of the NumberOfTreads attribute changed from "integer" to "IfcInteger" * IFC4X3_RC1 changes: * Supertype changed from "IfcBuildingElement" to "IfcBuiltElement" */ class IFC4X3_RC1_EXPORT IfcStairFlight : public IfcBuiltElement { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcStairFlight); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of NumberOfRisers attribute. This attribute represents number of the risers included in the stair flight. \returns Returns the value of NumberOfRisers attribute. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfRisers instead. */ int getNumberOfRisers() const; /** \details Sets the value of NumberOfRisers attribute. This attribute represents number of the risers included in the stair flight. \param NumberOfRisers [in] Number of risers to set. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfRisers instead. */ void setNumberOfRisers(int NumberOfRisers); /** \details Returns the value of NumberOfTreads attribute. This attribute represents number of treads included in the stair flight. \returns Returns the value of NumberOfTreads attribute. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfTreads instead. */ int getNumberOfTreads() const; /** \details Sets the value of NumberOfTreads attribute. This attribute represents number of treads included in the stair flight. \param NumberOfTreads [in] Number of treads to set. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfTreads instead. */ void setNumberOfTreads(int NumberOfTreads); /** \details Returns the value of RiserHeight attribute. This attribute represents vertical distance from tread to tread. The riser height is supposed to be equal for all stairs in a stair flight. \returns Returns the value of RiserHeight attribute. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.RiserHeight instead. */ double getRiserHeight() const; /** \details Sets the value of RiserHeight attribute. This attribute represents vertical distance from tread to tread. The riser height is supposed to be equal for all stairs in a stair flight. \param RiserHeight [in] Riser height to set. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.RiserHeight instead. */ void setRiserHeight(double RiserHeight); /** \details Returns the value of TreadLength attribute. This attribute represents horizontal distance from the front to the back of the tread. The tread length is supposed to be equal for all steps of the stair flight. \returns Returns the value of TreadLength attribute. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.TreadLength instead. */ double getTreadLength() const; /** \details Sets the value of TreadLength attribute. This attribute represents horizontal distance from the front to the back of the tread. The tread length is supposed to be equal for all steps of the stair flight. \param TreadLength [in] Tread length to set. \remarks IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.TreadLength instead. */ void setTreadLength(double TreadLength); /** \details Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a stair flight that is specified in an enumeration. There can be a property set specified specifically for the predefined types. \returns Returns the value of PredefinedType attribute. \remarks The PredefinedType is only used if no IfcStairFlightType is assigned, providing its own IfcStairFlightType.PredefinedType. */ IfcStairFlightTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a stair flight that is specified in an enumeration. There can be a property set specified specifically for the predefined types. \param PredefinedType [in] Predefined type to set. \remarks The PredefinedType is only used if no IfcStairFlightType is assigned, providing its own IfcStairFlightType.PredefinedType. */ void setPredefinedType(IfcStairFlightTypeEnum PredefinedType); public: /** \details Default constructor for the IfcStairFlight class. */ IfcStairFlight(); /** \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: int m_NumberOfRisers; // IfcInteger [optional] int m_NumberOfTreads; // IfcInteger [optional] IfcPositiveLengthMeasure m_RiserHeight; // IfcPositiveLengthMeasure [optional] IfcPositiveLengthMeasure m_TreadLength; // IfcPositiveLengthMeasure [optional] OdDAI::Enum m_PredefinedType; // IfcStairFlightTypeEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcStairFlight object. */ typedef OdSmartPtr IfcStairFlightPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X3_RC1_IFCSTAIRFLIGHT_AUTO_IMPL_H