src/model/CoilHeatingWaterBaseboardRadiant.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_COILHEATINGWATERBASEBOARDRADIANT_HPP | ||
| 7 | #define MODEL_COILHEATINGWATERBASEBOARDRADIANT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class CoilHeatingWaterBaseboardRadiant_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** CoilHeatingWaterBaseboardRadiant is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:Water:Baseboard:Radiant'. */ | ||
| 23 | class MODEL_API CoilHeatingWaterBaseboardRadiant : public StraightComponent | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit CoilHeatingWaterBaseboardRadiant(const Model& model); | ||
| 30 | |||
| 31 | 13 | virtual ~CoilHeatingWaterBaseboardRadiant() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | ✗ | CoilHeatingWaterBaseboardRadiant(const CoilHeatingWaterBaseboardRadiant& other) = default; | |
| 34 | 3 | CoilHeatingWaterBaseboardRadiant(CoilHeatingWaterBaseboardRadiant&& other) = default; | |
| 35 | ✗ | CoilHeatingWaterBaseboardRadiant& operator=(const CoilHeatingWaterBaseboardRadiant&) = default; | |
| 36 | ✗ | CoilHeatingWaterBaseboardRadiant& operator=(CoilHeatingWaterBaseboardRadiant&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | static std::vector<std::string> heatingDesignCapacityMethodValues(); | ||
| 43 | |||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | double ratedAverageWaterTemperature() const; | ||
| 48 | |||
| 49 | double ratedWaterMassFlowRate() const; | ||
| 50 | |||
| 51 | std::string heatingDesignCapacityMethod() const; | ||
| 52 | |||
| 53 | boost::optional<double> heatingDesignCapacity() const; | ||
| 54 | |||
| 55 | bool isHeatingDesignCapacityAutosized() const; | ||
| 56 | |||
| 57 | double heatingDesignCapacityPerFloorArea() const; | ||
| 58 | |||
| 59 | double fractionofAutosizedHeatingDesignCapacity() const; | ||
| 60 | |||
| 61 | boost::optional<double> maximumWaterFlowRate() const; | ||
| 62 | |||
| 63 | bool isMaximumWaterFlowRateAutosized() const; | ||
| 64 | |||
| 65 | double convergenceTolerance() const; | ||
| 66 | |||
| 67 | //@} | ||
| 68 | /** @name Setters */ | ||
| 69 | //@{ | ||
| 70 | |||
| 71 | bool setRatedAverageWaterTemperature(double ratedAverageWaterTemperature); | ||
| 72 | |||
| 73 | bool setRatedWaterMassFlowRate(double ratedWaterMassFlowRate); | ||
| 74 | |||
| 75 | bool setHeatingDesignCapacityMethod(const std::string& heatingDesignCapacityMethod); | ||
| 76 | |||
| 77 | bool setHeatingDesignCapacity(double heatingDesignCapacity); | ||
| 78 | |||
| 79 | void autosizeHeatingDesignCapacity(); | ||
| 80 | |||
| 81 | bool setHeatingDesignCapacityPerFloorArea(double heatingDesignCapacityPerFloorArea); | ||
| 82 | |||
| 83 | bool setFractionofAutosizedHeatingDesignCapacity(double fractionofAutosizedHeatingDesignCapacity); | ||
| 84 | |||
| 85 | bool setMaximumWaterFlowRate(double maximumWaterFlowRate); | ||
| 86 | |||
| 87 | void autosizeMaximumWaterFlowRate(); | ||
| 88 | |||
| 89 | bool setConvergenceTolerance(double convergenceTolerance); | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Other */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | boost::optional<double> autosizedHeatingDesignCapacity() const; | ||
| 96 | |||
| 97 | boost::optional<double> autosizedMaximumWaterFlowRate() const; | ||
| 98 | |||
| 99 | //@} | ||
| 100 | protected: | ||
| 101 | /// @cond | ||
| 102 | using ImplType = detail::CoilHeatingWaterBaseboardRadiant_Impl; | ||
| 103 | |||
| 104 | explicit CoilHeatingWaterBaseboardRadiant(std::shared_ptr<detail::CoilHeatingWaterBaseboardRadiant_Impl> impl); | ||
| 105 | |||
| 106 | friend class detail::CoilHeatingWaterBaseboardRadiant_Impl; | ||
| 107 | friend class Model; | ||
| 108 | friend class IdfObject; | ||
| 109 | friend class openstudio::detail::IdfObject_Impl; | ||
| 110 | /// @endcond | ||
| 111 | private: | ||
| 112 | REGISTER_LOGGER("openstudio.model.CoilHeatingWaterBaseboardRadiant"); | ||
| 113 | }; | ||
| 114 | |||
| 115 | /** \relates CoilHeatingWaterBaseboardRadiant*/ | ||
| 116 | using OptionalCoilHeatingWaterBaseboardRadiant = boost::optional<CoilHeatingWaterBaseboardRadiant>; | ||
| 117 | |||
| 118 | /** \relates CoilHeatingWaterBaseboardRadiant*/ | ||
| 119 | using CoilHeatingWaterBaseboardRadiantVector = std::vector<CoilHeatingWaterBaseboardRadiant>; | ||
| 120 | |||
| 121 | } // namespace model | ||
| 122 | } // namespace openstudio | ||
| 123 | |||
| 124 | #endif // MODEL_COILHEATINGWATERBASEBOARDRADIANT_HPP | ||
| 125 |