src/model/HumidifierSteamGas.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_HUMIDIFIERSTEAMGAS_HPP | ||
| 7 | #define MODEL_HUMIDIFIERSTEAMGAS_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Curve; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class HumidifierSteamGas_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** HumidifierSteamGas is a StraightComponent that wraps the OpenStudio IDD object 'OS:Humidifier:Steam:Gas'. */ | ||
| 26 | class MODEL_API HumidifierSteamGas : public StraightComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit HumidifierSteamGas(const Model& model); | ||
| 33 | |||
| 34 | 6 | virtual ~HumidifierSteamGas() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | HumidifierSteamGas(const HumidifierSteamGas& other) = default; | |
| 37 | ✗ | HumidifierSteamGas(HumidifierSteamGas&& other) = default; | |
| 38 | ✗ | HumidifierSteamGas& operator=(const HumidifierSteamGas&) = default; | |
| 39 | ✗ | HumidifierSteamGas& operator=(HumidifierSteamGas&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | /** @name Getters */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 49 | |||
| 50 | boost::optional<double> ratedCapacity() const; | ||
| 51 | |||
| 52 | bool isRatedCapacityAutosized() const; | ||
| 53 | |||
| 54 | boost::optional<double> ratedGasUseRate() const; | ||
| 55 | |||
| 56 | bool isRatedGasUseRateAutosized() const; | ||
| 57 | |||
| 58 | double thermalEfficiency() const; | ||
| 59 | |||
| 60 | bool isThermalEfficiencyDefaulted() const; | ||
| 61 | |||
| 62 | boost::optional<Curve> thermalEfficiencyModifierCurve() const; | ||
| 63 | |||
| 64 | boost::optional<double> ratedFanPower() const; | ||
| 65 | |||
| 66 | double auxiliaryElectricPower() const; | ||
| 67 | |||
| 68 | bool isAuxiliaryElectricPowerDefaulted() const; | ||
| 69 | |||
| 70 | // boost::optional<WaterStorageTank> waterStorageTank() const; | ||
| 71 | |||
| 72 | std::string inletWaterTemperatureOption() const; | ||
| 73 | |||
| 74 | bool isInletWaterTemperatureOptionDefaulted() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 81 | |||
| 82 | void resetAvailabilitySchedule(); | ||
| 83 | |||
| 84 | bool setRatedCapacity(double ratedCapacity); | ||
| 85 | |||
| 86 | void autosizeRatedCapacity(); | ||
| 87 | |||
| 88 | bool setRatedGasUseRate(double ratedGasUseRate); | ||
| 89 | |||
| 90 | void resetRatedGasUseRate(); | ||
| 91 | |||
| 92 | void autosizeRatedGasUseRate(); | ||
| 93 | |||
| 94 | bool setThermalEfficiency(double thermalEfficiency); | ||
| 95 | |||
| 96 | void resetThermalEfficiency(); | ||
| 97 | |||
| 98 | bool setThermalEfficiencyModifierCurve(const Curve& curve); | ||
| 99 | |||
| 100 | void resetThermalEfficiencyModifierCurve(); | ||
| 101 | |||
| 102 | bool setRatedFanPower(double ratedFanPower); | ||
| 103 | |||
| 104 | void resetRatedFanPower(); | ||
| 105 | |||
| 106 | bool setAuxiliaryElectricPower(double auxiliaryElectricPower); | ||
| 107 | |||
| 108 | void resetAuxiliaryElectricPower(); | ||
| 109 | |||
| 110 | // bool setWaterStorageTank(const boost::optional<WaterStorageTank>& waterStorageTank); | ||
| 111 | |||
| 112 | // void resetWaterStorageTank(); | ||
| 113 | |||
| 114 | bool setInletWaterTemperatureOption(const std::string& inletWaterTemperatureOption); | ||
| 115 | |||
| 116 | void resetInletWaterTemperatureOption(); | ||
| 117 | |||
| 118 | //@} | ||
| 119 | /** @name Other */ | ||
| 120 | //@{ | ||
| 121 | |||
| 122 | boost::optional<double> autosizedRatedCapacity() const; | ||
| 123 | |||
| 124 | boost::optional<double> autosizedRatedGasUseRate() const; | ||
| 125 | |||
| 126 | //@} | ||
| 127 | protected: | ||
| 128 | /// @cond | ||
| 129 | using ImplType = detail::HumidifierSteamGas_Impl; | ||
| 130 | |||
| 131 | explicit HumidifierSteamGas(std::shared_ptr<detail::HumidifierSteamGas_Impl> impl); | ||
| 132 | |||
| 133 | friend class detail::HumidifierSteamGas_Impl; | ||
| 134 | friend class Model; | ||
| 135 | friend class IdfObject; | ||
| 136 | friend class openstudio::detail::IdfObject_Impl; | ||
| 137 | /// @endcond | ||
| 138 | private: | ||
| 139 | REGISTER_LOGGER("openstudio.model.HumidifierSteamGas"); | ||
| 140 | }; | ||
| 141 | |||
| 142 | /** \relates HumidifierSteamGas*/ | ||
| 143 | using OptionalHumidifierSteamGas = boost::optional<HumidifierSteamGas>; | ||
| 144 | |||
| 145 | /** \relates HumidifierSteamGas*/ | ||
| 146 | using HumidifierSteamGasVector = std::vector<HumidifierSteamGas>; | ||
| 147 | |||
| 148 | } // namespace model | ||
| 149 | } // namespace openstudio | ||
| 150 | |||
| 151 | #endif // MODEL_HUMIDIFIERSTEAMGAS_HPP | ||
| 152 |