/////////////////////////////////////////////////////////////////////////////// // 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_IFCRAMPFLIGHT_AUTO_IMPL_H #define _IFC4X2_IFCRAMPFLIGHT_AUTO_IMPL_H #include "IfcBuildingElementAutoImpl.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 ramp comprises a single inclined segment, or several inclined segments that are connected by a horizontal segment, referred to as a landing. A ramp flight is the single inclined segment and part of the ramp construction. In case of single flight ramps, the ramp flight and the ramp are identical. An IfcRampFlight is an aggregated part of an IfcRamp realized through the IfcRelAggregates relationship, the ramp flight is therefore included in the set of IfcRelAggregates.RelatedObjects. An IfcRampFlight connects the floor slab of zero to two different storeys (or partial storeys or landings) within a building. The connection relationship between the IfcRampFlight 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 following additional constraints apply to the 'SweptSolid' representation type: * Solid: IfcExtrudedAreaSolid is required * Profile: IfcRectangleProfileDef and IfcArbitraryClosedProfileDef is supported * Extrusion: The profile is extruded in any direction relative to the XY plane of the position coordinate system of the IfcExtrudedAreaSolid. Therefore non-perpendicular sweep operation has to be supported. It might be further constrained to be in the direction of the global z-axis in implementers agreements The image below illustrates the body representation. - 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 - Material Single - The material of the IfcRampFlight is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. - Object Typing - This concept can be applied to the following resources: * IfcRampFlightType - Property Sets for Objects - This concept can be applied to the following resources: * Pset_ConcreteElementGeneral * Pset_PrecastConcreteElementFabrication * Pset_PrecastConcreteElementGeneral * Pset_RampFlightCommon - Quantity Sets - This concept can be applied to the following resources: * Qto_RampFlightBaseQuantities - Spatial Containment - The IfcRampFlight, 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 IFC4X2_EXPORT IfcRampFlight : public IfcBuildingElement { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcRampFlight); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a ramp 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 IfcRampFlightType is assigned, providing its own IfcRampFlightType.PredefinedType. */ IfcRampFlightTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a ramp 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 IfcRampFlightType is assigned, providing its own IfcRampFlightType.PredefinedType. */ void setPredefinedType(IfcRampFlightTypeEnum PredefinedType); public: /** \details Default constructor for the IfcRampFlight class. */ IfcRampFlight(); /** \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; // IfcRampFlightTypeEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcRampFlight object. */ typedef OdSmartPtr IfcRampFlightPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCRAMPFLIGHT_AUTO_IMPL_H