src/model/CoilHeatingWaterBaseboard.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_COILHEATINGWATERBASEBOARD_HPP | ||
| 7 | #define MODEL_COILHEATINGWATERBASEBOARD_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 CoilHeatingWaterBaseboard_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** CoilHeatingWaterBaseboard is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:Water:Baseboard'. */ | ||
| 23 | class MODEL_API CoilHeatingWaterBaseboard : public StraightComponent | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | CoilHeatingWaterBaseboard(const Model& model); | ||
| 30 | |||
| 31 | 5 | virtual ~CoilHeatingWaterBaseboard() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | ✗ | CoilHeatingWaterBaseboard(const CoilHeatingWaterBaseboard& other) = default; | |
| 34 | ✗ | CoilHeatingWaterBaseboard(CoilHeatingWaterBaseboard&& other) = default; | |
| 35 | ✗ | CoilHeatingWaterBaseboard& operator=(const CoilHeatingWaterBaseboard&) = default; | |
| 36 | ✗ | CoilHeatingWaterBaseboard& operator=(CoilHeatingWaterBaseboard&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | static std::vector<std::string> heatingDesignCapacityMethodValues(); | ||
| 43 | |||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | unsigned inletPort() const; | ||
| 48 | |||
| 49 | unsigned outletPort() 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 | /** Returns the value of the UFactorTimesAreaValue field. **/ | ||
| 62 | boost::optional<double> uFactorTimesAreaValue() const; | ||
| 63 | |||
| 64 | bool isUFactorTimesAreaValueDefaulted() const; | ||
| 65 | |||
| 66 | /** Returns true if the UFactorTimesAreaValue field is set to autosize **/ | ||
| 67 | bool isUFactorTimesAreaValueAutosized() const; | ||
| 68 | |||
| 69 | /** Returns the value of the MaximumWaterFlowRate field. **/ | ||
| 70 | boost::optional<double> maximumWaterFlowRate() const; | ||
| 71 | |||
| 72 | bool isMaximumWaterFlowRateDefaulted() const; | ||
| 73 | |||
| 74 | bool isMaximumWaterFlowRateAutosized() const; | ||
| 75 | |||
| 76 | double convergenceTolerance() const; | ||
| 77 | |||
| 78 | bool isConvergenceToleranceDefaulted() const; | ||
| 79 | |||
| 80 | //@} | ||
| 81 | /** @name Setters */ | ||
| 82 | //@{ | ||
| 83 | bool setHeatingDesignCapacityMethod(const std::string& heatingDesignCapacityMethod); | ||
| 84 | |||
| 85 | bool setHeatingDesignCapacity(double heatingDesignCapacity); | ||
| 86 | |||
| 87 | void autosizeHeatingDesignCapacity(); | ||
| 88 | |||
| 89 | bool setHeatingDesignCapacityPerFloorArea(double heatingDesignCapacityPerFloorArea); | ||
| 90 | |||
| 91 | bool setFractionofAutosizedHeatingDesignCapacity(double fractionofAutosizedHeatingDesignCapacity); | ||
| 92 | |||
| 93 | bool setUFactorTimesAreaValue(double uFactorTimesAreaValue); | ||
| 94 | |||
| 95 | void resetUFactorTimesAreaValue(); | ||
| 96 | |||
| 97 | void autosizeUFactorTimesAreaValue(); | ||
| 98 | |||
| 99 | bool setMaximumWaterFlowRate(double maximumWaterFlowRate); | ||
| 100 | |||
| 101 | void resetMaximumWaterFlowRate(); | ||
| 102 | |||
| 103 | void autosizeMaximumWaterFlowRate(); | ||
| 104 | |||
| 105 | bool setConvergenceTolerance(double convergenceTolerance); | ||
| 106 | |||
| 107 | void resetConvergenceTolerance(); | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Other */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | boost::optional<double> autosizedHeatingDesignCapacity() const; | ||
| 114 | |||
| 115 | boost::optional<double> autosizedUFactorTimesAreaValue() const; | ||
| 116 | |||
| 117 | boost::optional<double> autosizedMaximumWaterFlowRate() const; | ||
| 118 | |||
| 119 | //@} | ||
| 120 | protected: | ||
| 121 | /// @cond | ||
| 122 | using ImplType = detail::CoilHeatingWaterBaseboard_Impl; | ||
| 123 | |||
| 124 | explicit CoilHeatingWaterBaseboard(std::shared_ptr<detail::CoilHeatingWaterBaseboard_Impl> impl); | ||
| 125 | |||
| 126 | friend class detail::CoilHeatingWaterBaseboard_Impl; | ||
| 127 | friend class Model; | ||
| 128 | friend class IdfObject; | ||
| 129 | friend class openstudio::detail::IdfObject_Impl; | ||
| 130 | /// @endcond | ||
| 131 | private: | ||
| 132 | REGISTER_LOGGER("openstudio.model.CoilHeatingWaterBaseboard"); | ||
| 133 | }; | ||
| 134 | |||
| 135 | /** \relates CoilHeatingWaterBaseboard*/ | ||
| 136 | using OptionalCoilHeatingWaterBaseboard = boost::optional<CoilHeatingWaterBaseboard>; | ||
| 137 | |||
| 138 | /** \relates CoilHeatingWaterBaseboard*/ | ||
| 139 | using CoilHeatingWaterBaseboardVector = std::vector<CoilHeatingWaterBaseboard>; | ||
| 140 | |||
| 141 | } // namespace model | ||
| 142 | } // namespace openstudio | ||
| 143 | |||
| 144 | #endif // MODEL_COILHEATINGWATERBASEBOARD_HPP | ||
| 145 |