src/model/AirflowNetworkEffectiveLeakageArea.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_AIRFLOWNETWORKEFFECTIVELEAKAGEAREA_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKEFFECTIVELEAKAGEAREA_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | |||
| 11 | #include "AirflowNetworkComponent.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class AirflowNetworkEffectiveLeakageArea_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** AirflowNetworkEffectiveLeakageArea is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetworkEffectiveLeakageArea'. */ | ||
| 24 | class MODEL_API AirflowNetworkEffectiveLeakageArea : public AirflowNetworkComponent | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | /** Construct an effective leakage area object with default values and a specified effective leakage area. */ | ||
| 30 | AirflowNetworkEffectiveLeakageArea(const Model& model, double effectiveLeakageArea); | ||
| 31 | /** Construct an effective leakage area object. */ | ||
| 32 | AirflowNetworkEffectiveLeakageArea(const Model& model, double effectiveLeakageArea, double dischargeCoefficient, | ||
| 33 | double referencePressureDifference, double massFlowExponent); | ||
| 34 | |||
| 35 | 5 | virtual ~AirflowNetworkEffectiveLeakageArea() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | AirflowNetworkEffectiveLeakageArea(const AirflowNetworkEffectiveLeakageArea& other) = default; | |
| 38 | 1 | AirflowNetworkEffectiveLeakageArea(AirflowNetworkEffectiveLeakageArea&& other) = default; | |
| 39 | ✗ | AirflowNetworkEffectiveLeakageArea& operator=(const AirflowNetworkEffectiveLeakageArea&) = default; | |
| 40 | ✗ | AirflowNetworkEffectiveLeakageArea& operator=(AirflowNetworkEffectiveLeakageArea&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | /** Returns the effective leakage area in square meters. */ | ||
| 49 | double effectiveLeakageArea() const; | ||
| 50 | /** Returns the discharge coefficient. */ | ||
| 51 | double dischargeCoefficient() const; | ||
| 52 | /** Returns true if the discharge coefficient is defaulted. */ | ||
| 53 | bool isDischargeCoefficientDefaulted() const; | ||
| 54 | /** Returns the reference pressure difference in Pa. */ | ||
| 55 | double referencePressureDifference() const; | ||
| 56 | /** Returns true if the reference pressure difference is defaulted. */ | ||
| 57 | bool isReferencePressureDifferenceDefaulted() const; | ||
| 58 | /** Returns the mass flow exponent. */ | ||
| 59 | double airMassFlowExponent() const; | ||
| 60 | /** Returns true if the mass flow exponent. */ | ||
| 61 | bool isAirMassFlowExponentDefaulted() const; | ||
| 62 | |||
| 63 | //@} | ||
| 64 | /** @name Setters */ | ||
| 65 | //@{ | ||
| 66 | /** Sets the effective leakage area in square meters. */ | ||
| 67 | bool setEffectiveLeakageArea(double effectiveLeakageArea); | ||
| 68 | /** Sets the discharge coefficient. */ | ||
| 69 | bool setDischargeCoefficient(double dischargeCoefficient); | ||
| 70 | /** Returns the discharge coefficient to the default value. */ | ||
| 71 | void resetDischargeCoefficient(); | ||
| 72 | /** Sets the reference pressure difference in Pa. */ | ||
| 73 | bool setReferencePressureDifference(double referencePressureDifference); | ||
| 74 | /** Returns the reference pressure difference to the default value. */ | ||
| 75 | void resetReferencePressureDifference(); | ||
| 76 | /** Sets the mass flow exponent. */ | ||
| 77 | bool setAirMassFlowExponent(double airMassFlowExponent); | ||
| 78 | /** Returns the mass flow exponent to the default value. */ | ||
| 79 | void resetAirMassFlowExponent(); | ||
| 80 | |||
| 81 | //@} | ||
| 82 | protected: | ||
| 83 | /// @cond | ||
| 84 | using ImplType = detail::AirflowNetworkEffectiveLeakageArea_Impl; | ||
| 85 | |||
| 86 | explicit AirflowNetworkEffectiveLeakageArea(std::shared_ptr<detail::AirflowNetworkEffectiveLeakageArea_Impl> impl); | ||
| 87 | |||
| 88 | friend class detail::AirflowNetworkEffectiveLeakageArea_Impl; | ||
| 89 | friend class Model; | ||
| 90 | friend class IdfObject; | ||
| 91 | friend class openstudio::detail::IdfObject_Impl; | ||
| 92 | /// @endcond | ||
| 93 | private: | ||
| 94 | REGISTER_LOGGER("openstudio.model.AirflowNetworkEffectiveLeakageArea"); | ||
| 95 | }; | ||
| 96 | |||
| 97 | /** \relates AirflowNetworkEffectiveLeakageArea*/ | ||
| 98 | using OptionalAirflowNetworkEffectiveLeakageArea = boost::optional<AirflowNetworkEffectiveLeakageArea>; | ||
| 99 | |||
| 100 | /** \relates AirflowNetworkEffectiveLeakageArea*/ | ||
| 101 | using AirflowNetworkEffectiveLeakageAreaVector = std::vector<AirflowNetworkEffectiveLeakageArea>; | ||
| 102 | |||
| 103 | } // namespace model | ||
| 104 | } // namespace openstudio | ||
| 105 | |||
| 106 | #endif // MODEL_AIRFLOWNETWORKEFFECTIVELEAKAGEAREA_HPP | ||
| 107 |