src/model/WaterHeaterSizing.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_WATERHEATERSIZING_HPP | ||
| 7 | #define MODEL_WATERHEATERSIZING_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class WaterToWaterComponent; | ||
| 17 | class WaterHeaterMixed; | ||
| 18 | class WaterHeaterStratified; | ||
| 19 | class ThermalStorageChilledWaterStratified; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class WaterHeaterSizing_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** WaterHeaterSizing is a ModelObject that wraps the OpenStudio IDD object 'OS:WaterHeater:Sizing'. */ | ||
| 28 | class MODEL_API WaterHeaterSizing : public ModelObject | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | 620 | virtual ~WaterHeaterSizing() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 242 | WaterHeaterSizing(const WaterHeaterSizing& other) = default; | |
| 37 | 129 | WaterHeaterSizing(WaterHeaterSizing&& other) = default; | |
| 38 | ✗ | WaterHeaterSizing& operator=(const WaterHeaterSizing&) = default; | |
| 39 | 2 | WaterHeaterSizing& operator=(WaterHeaterSizing&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> designModeValues(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | WaterToWaterComponent waterHeater() const; | ||
| 51 | |||
| 52 | boost::optional<std::string> designMode() const; | ||
| 53 | |||
| 54 | boost::optional<double> timeStorageCanMeetPeakDraw() const; | ||
| 55 | |||
| 56 | boost::optional<double> timeforTankRecovery() const; | ||
| 57 | |||
| 58 | boost::optional<double> nominalTankVolumeforAutosizingPlantConnections() const; | ||
| 59 | |||
| 60 | boost::optional<int> numberofBedrooms() const; | ||
| 61 | |||
| 62 | boost::optional<int> numberofBathrooms() const; | ||
| 63 | |||
| 64 | boost::optional<double> storageCapacityperPerson() const; | ||
| 65 | |||
| 66 | boost::optional<double> recoveryCapacityperPerson() const; | ||
| 67 | |||
| 68 | boost::optional<double> storageCapacityperFloorArea() const; | ||
| 69 | |||
| 70 | boost::optional<double> recoveryCapacityperFloorArea() const; | ||
| 71 | |||
| 72 | boost::optional<double> numberofUnits() const; | ||
| 73 | |||
| 74 | boost::optional<double> storageCapacityperUnit() const; | ||
| 75 | |||
| 76 | boost::optional<double> recoveryCapacityPerUnit() const; | ||
| 77 | |||
| 78 | boost::optional<double> storageCapacityperCollectorArea() const; | ||
| 79 | |||
| 80 | boost::optional<double> heightAspectRatio() const; | ||
| 81 | |||
| 82 | //@} | ||
| 83 | /** @name Setters */ | ||
| 84 | //@{ | ||
| 85 | |||
| 86 | bool setDesignMode(const std::string& designMode); | ||
| 87 | |||
| 88 | void resetDesignMode(); | ||
| 89 | |||
| 90 | bool setTimeStorageCanMeetPeakDraw(double timeStorageCanMeetPeakDraw); | ||
| 91 | |||
| 92 | void resetTimeStorageCanMeetPeakDraw(); | ||
| 93 | |||
| 94 | bool setTimeforTankRecovery(double timeforTankRecovery); | ||
| 95 | |||
| 96 | void resetTimeforTankRecovery(); | ||
| 97 | |||
| 98 | bool setNominalTankVolumeforAutosizingPlantConnections(double nominalTankVolumeforAutosizingPlantConnections); | ||
| 99 | |||
| 100 | void resetNominalTankVolumeforAutosizingPlantConnections(); | ||
| 101 | |||
| 102 | bool setNumberofBedrooms(int numberofBedrooms); | ||
| 103 | |||
| 104 | void resetNumberofBedrooms(); | ||
| 105 | |||
| 106 | bool setNumberofBathrooms(int numberofBathrooms); | ||
| 107 | |||
| 108 | void resetNumberofBathrooms(); | ||
| 109 | |||
| 110 | bool setStorageCapacityperPerson(double storageCapacityperPerson); | ||
| 111 | |||
| 112 | void resetStorageCapacityperPerson(); | ||
| 113 | |||
| 114 | bool setRecoveryCapacityperPerson(double recoveryCapacityperPerson); | ||
| 115 | |||
| 116 | void resetRecoveryCapacityperPerson(); | ||
| 117 | |||
| 118 | bool setStorageCapacityperFloorArea(double storageCapacityperFloorArea); | ||
| 119 | |||
| 120 | void resetStorageCapacityperFloorArea(); | ||
| 121 | |||
| 122 | bool setRecoveryCapacityperFloorArea(double recoveryCapacityperFloorArea); | ||
| 123 | |||
| 124 | void resetRecoveryCapacityperFloorArea(); | ||
| 125 | |||
| 126 | bool setNumberofUnits(double numberofUnits); | ||
| 127 | |||
| 128 | void resetNumberofUnits(); | ||
| 129 | |||
| 130 | bool setStorageCapacityperUnit(double storageCapacityperUnit); | ||
| 131 | |||
| 132 | void resetStorageCapacityperUnit(); | ||
| 133 | |||
| 134 | bool setRecoveryCapacityPerUnit(double recoveryCapacityPerUnit); | ||
| 135 | |||
| 136 | void resetRecoveryCapacityPerUnit(); | ||
| 137 | |||
| 138 | bool setStorageCapacityperCollectorArea(double storageCapacityperCollectorArea); | ||
| 139 | |||
| 140 | void resetStorageCapacityperCollectorArea(); | ||
| 141 | |||
| 142 | bool setHeightAspectRatio(double heightAspectRatio); | ||
| 143 | |||
| 144 | void resetHeightAspectRatio(); | ||
| 145 | |||
| 146 | //@} | ||
| 147 | /** @name Other */ | ||
| 148 | //@{ | ||
| 149 | |||
| 150 | //@} | ||
| 151 | protected: | ||
| 152 | /// @cond | ||
| 153 | |||
| 154 | friend class WaterHeaterMixed; | ||
| 155 | friend class WaterHeaterStratified; | ||
| 156 | friend class ThermalStorageChilledWaterStratified; | ||
| 157 | |||
| 158 | explicit WaterHeaterSizing(const WaterToWaterComponent& waterHeater); | ||
| 159 | bool setWaterHeater(const WaterToWaterComponent& waterHeater); | ||
| 160 | |||
| 161 | using ImplType = detail::WaterHeaterSizing_Impl; | ||
| 162 | |||
| 163 | explicit WaterHeaterSizing(std::shared_ptr<detail::WaterHeaterSizing_Impl> impl); | ||
| 164 | |||
| 165 | friend class detail::WaterHeaterSizing_Impl; | ||
| 166 | friend class Model; | ||
| 167 | friend class IdfObject; | ||
| 168 | friend class openstudio::detail::IdfObject_Impl; | ||
| 169 | /// @endcond | ||
| 170 | private: | ||
| 171 | − | REGISTER_LOGGER("openstudio.model.WaterHeaterSizing"); | |
| 172 | }; | ||
| 173 | |||
| 174 | /** \relates WaterHeaterSizing*/ | ||
| 175 | using OptionalWaterHeaterSizing = boost::optional<WaterHeaterSizing>; | ||
| 176 | |||
| 177 | /** \relates WaterHeaterSizing*/ | ||
| 178 | using WaterHeaterSizingVector = std::vector<WaterHeaterSizing>; | ||
| 179 | |||
| 180 | } // namespace model | ||
| 181 | } // namespace openstudio | ||
| 182 | |||
| 183 | #endif // MODEL_WATERHEATERSIZING_HPP | ||
| 184 |