src/model/ZoneHVACIdealLoadsAirSystem.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_ZONEHVACIDEALLOADSAIRSYSTEM_HPP | ||
| 7 | #define MODEL_ZONEHVACIDEALLOADSAIRSYSTEM_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class DesignSpecificationOutdoorAir; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACIdealLoadsAirSystem_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACIdealLoadsAirSystem is a ZoneHVACComponent that wraps the OpenStudio IDD | ||
| 26 | * object 'OS:ZoneHVAC:IdealLoadsAirSystem'. */ | ||
| 27 | class MODEL_API ZoneHVACIdealLoadsAirSystem : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit ZoneHVACIdealLoadsAirSystem(const Model& model); | ||
| 34 | |||
| 35 | 12 | virtual ~ZoneHVACIdealLoadsAirSystem() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | ZoneHVACIdealLoadsAirSystem(const ZoneHVACIdealLoadsAirSystem& other) = default; | |
| 38 | 4 | ZoneHVACIdealLoadsAirSystem(ZoneHVACIdealLoadsAirSystem&& other) = default; | |
| 39 | ✗ | ZoneHVACIdealLoadsAirSystem& operator=(const ZoneHVACIdealLoadsAirSystem&) = default; | |
| 40 | ✗ | ZoneHVACIdealLoadsAirSystem& operator=(ZoneHVACIdealLoadsAirSystem&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> heatingLimitValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> coolingLimitValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> dehumidificationControlTypeValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> humidificationControlTypeValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> demandControlledVentilationTypeValues(); | ||
| 55 | |||
| 56 | static std::vector<std::string> outdoorAirEconomizerTypeValues(); | ||
| 57 | |||
| 58 | static std::vector<std::string> heatRecoveryTypeValues(); | ||
| 59 | |||
| 60 | static std::vector<std::string> heatingFuelTypeValues(); | ||
| 61 | |||
| 62 | static std::vector<std::string> coolingFuelTypeValues(); | ||
| 63 | |||
| 64 | /** @name Getters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 68 | |||
| 69 | double maximumHeatingSupplyAirTemperature() const; | ||
| 70 | |||
| 71 | bool isMaximumHeatingSupplyAirTemperatureDefaulted() const; | ||
| 72 | |||
| 73 | double minimumCoolingSupplyAirTemperature() const; | ||
| 74 | |||
| 75 | bool isMinimumCoolingSupplyAirTemperatureDefaulted() const; | ||
| 76 | |||
| 77 | double maximumHeatingSupplyAirHumidityRatio() const; | ||
| 78 | |||
| 79 | bool isMaximumHeatingSupplyAirHumidityRatioDefaulted() const; | ||
| 80 | |||
| 81 | double minimumCoolingSupplyAirHumidityRatio() const; | ||
| 82 | |||
| 83 | bool isMinimumCoolingSupplyAirHumidityRatioDefaulted() const; | ||
| 84 | |||
| 85 | std::string heatingLimit() const; | ||
| 86 | |||
| 87 | bool isHeatingLimitDefaulted() const; | ||
| 88 | |||
| 89 | boost::optional<double> maximumHeatingAirFlowRate() const; | ||
| 90 | |||
| 91 | bool isMaximumHeatingAirFlowRateAutosized() const; | ||
| 92 | |||
| 93 | boost::optional<double> maximumSensibleHeatingCapacity() const; | ||
| 94 | |||
| 95 | bool isMaximumSensibleHeatingCapacityAutosized() const; | ||
| 96 | |||
| 97 | std::string coolingLimit() const; | ||
| 98 | |||
| 99 | bool isCoolingLimitDefaulted() const; | ||
| 100 | |||
| 101 | boost::optional<double> maximumCoolingAirFlowRate() const; | ||
| 102 | |||
| 103 | bool isMaximumCoolingAirFlowRateAutosized() const; | ||
| 104 | |||
| 105 | boost::optional<double> maximumTotalCoolingCapacity() const; | ||
| 106 | |||
| 107 | bool isMaximumTotalCoolingCapacityAutosized() const; | ||
| 108 | |||
| 109 | boost::optional<Schedule> heatingAvailabilitySchedule() const; | ||
| 110 | |||
| 111 | boost::optional<Schedule> coolingAvailabilitySchedule() const; | ||
| 112 | |||
| 113 | std::string dehumidificationControlType() const; | ||
| 114 | |||
| 115 | bool isDehumidificationControlTypeDefaulted() const; | ||
| 116 | |||
| 117 | double coolingSensibleHeatRatio() const; | ||
| 118 | |||
| 119 | bool isCoolingSensibleHeatRatioDefaulted() const; | ||
| 120 | |||
| 121 | std::string humidificationControlType() const; | ||
| 122 | |||
| 123 | bool isHumidificationControlTypeDefaulted() const; | ||
| 124 | |||
| 125 | // TODO: should replace this with a "Control For Outdoor Air" field | ||
| 126 | boost::optional<DesignSpecificationOutdoorAir> designSpecificationOutdoorAirObject() const; | ||
| 127 | |||
| 128 | std::string demandControlledVentilationType() const; | ||
| 129 | |||
| 130 | bool isDemandControlledVentilationTypeDefaulted() const; | ||
| 131 | |||
| 132 | std::string outdoorAirEconomizerType() const; | ||
| 133 | |||
| 134 | bool isOutdoorAirEconomizerTypeDefaulted() const; | ||
| 135 | |||
| 136 | std::string heatRecoveryType() const; | ||
| 137 | |||
| 138 | bool isHeatRecoveryTypeDefaulted() const; | ||
| 139 | |||
| 140 | double sensibleHeatRecoveryEffectiveness() const; | ||
| 141 | |||
| 142 | bool isSensibleHeatRecoveryEffectivenessDefaulted() const; | ||
| 143 | |||
| 144 | double latentHeatRecoveryEffectiveness() const; | ||
| 145 | |||
| 146 | bool isLatentHeatRecoveryEffectivenessDefaulted() const; | ||
| 147 | |||
| 148 | boost::optional<Schedule> heatingFuelEfficiencySchedule() const; | ||
| 149 | |||
| 150 | std::string heatingFuelType() const; | ||
| 151 | |||
| 152 | boost::optional<Schedule> coolingFuelEfficiencySchedule() const; | ||
| 153 | |||
| 154 | std::string coolingFuelType() const; | ||
| 155 | |||
| 156 | //@} | ||
| 157 | /** @name Setters */ | ||
| 158 | //@{ | ||
| 159 | |||
| 160 | bool setAvailabilitySchedule(Schedule& availabilitySchedule); | ||
| 161 | |||
| 162 | void resetAvailabilitySchedule(); | ||
| 163 | |||
| 164 | bool setMaximumHeatingSupplyAirTemperature(double maximumHeatingSupplyAirTemperature); | ||
| 165 | |||
| 166 | void resetMaximumHeatingSupplyAirTemperature(); | ||
| 167 | |||
| 168 | bool setMinimumCoolingSupplyAirTemperature(double minimumCoolingSupplyAirTemperature); | ||
| 169 | |||
| 170 | void resetMinimumCoolingSupplyAirTemperature(); | ||
| 171 | |||
| 172 | bool setMaximumHeatingSupplyAirHumidityRatio(double maximumHeatingSupplyAirHumidityRatio); | ||
| 173 | |||
| 174 | void resetMaximumHeatingSupplyAirHumidityRatio(); | ||
| 175 | |||
| 176 | bool setMinimumCoolingSupplyAirHumidityRatio(double minimumCoolingSupplyAirHumidityRatio); | ||
| 177 | |||
| 178 | void resetMinimumCoolingSupplyAirHumidityRatio(); | ||
| 179 | |||
| 180 | bool setHeatingLimit(const std::string& heatingLimit); | ||
| 181 | |||
| 182 | void resetHeatingLimit(); | ||
| 183 | |||
| 184 | bool setMaximumHeatingAirFlowRate(double maximumHeatingAirFlowRate); | ||
| 185 | |||
| 186 | void resetMaximumHeatingAirFlowRate(); | ||
| 187 | |||
| 188 | void autosizeMaximumHeatingAirFlowRate(); | ||
| 189 | |||
| 190 | bool setMaximumSensibleHeatingCapacity(double maximumSensibleHeatingCapacity); | ||
| 191 | |||
| 192 | void resetMaximumSensibleHeatingCapacity(); | ||
| 193 | |||
| 194 | void autosizeMaximumSensibleHeatingCapacity(); | ||
| 195 | |||
| 196 | bool setCoolingLimit(const std::string& coolingLimit); | ||
| 197 | |||
| 198 | void resetCoolingLimit(); | ||
| 199 | |||
| 200 | bool setMaximumCoolingAirFlowRate(double maximumCoolingAirFlowRate); | ||
| 201 | |||
| 202 | void resetMaximumCoolingAirFlowRate(); | ||
| 203 | |||
| 204 | void autosizeMaximumCoolingAirFlowRate(); | ||
| 205 | |||
| 206 | bool setMaximumTotalCoolingCapacity(double maximumTotalCoolingCapacity); | ||
| 207 | |||
| 208 | void resetMaximumTotalCoolingCapacity(); | ||
| 209 | |||
| 210 | void autosizeMaximumTotalCoolingCapacity(); | ||
| 211 | |||
| 212 | bool setHeatingAvailabilitySchedule(Schedule& heatingAvailabilitySchedule); | ||
| 213 | |||
| 214 | void resetHeatingAvailabilitySchedule(); | ||
| 215 | |||
| 216 | bool setCoolingAvailabilitySchedule(Schedule& coolingAvailabilitySchedule); | ||
| 217 | |||
| 218 | void resetCoolingAvailabilitySchedule(); | ||
| 219 | |||
| 220 | bool setDehumidificationControlType(const std::string& dehumidificationControlType); | ||
| 221 | |||
| 222 | void resetDehumidificationControlType(); | ||
| 223 | |||
| 224 | bool setCoolingSensibleHeatRatio(double coolingSensibleHeatRatio); | ||
| 225 | |||
| 226 | void resetCoolingSensibleHeatRatio(); | ||
| 227 | |||
| 228 | bool setHumidificationControlType(const std::string& humidificationControlType); | ||
| 229 | |||
| 230 | void resetHumidificationControlType(); | ||
| 231 | |||
| 232 | bool setDesignSpecificationOutdoorAirObject(const DesignSpecificationOutdoorAir& designSpecificationOutdoorAirObject); | ||
| 233 | |||
| 234 | void resetDesignSpecificationOutdoorAirObject(); | ||
| 235 | |||
| 236 | bool setDemandControlledVentilationType(const std::string& demandControlledVentilationType); | ||
| 237 | |||
| 238 | void resetDemandControlledVentilationType(); | ||
| 239 | |||
| 240 | bool setOutdoorAirEconomizerType(const std::string& outdoorAirEconomizerType); | ||
| 241 | |||
| 242 | void resetOutdoorAirEconomizerType(); | ||
| 243 | |||
| 244 | bool setHeatRecoveryType(const std::string& heatRecoveryType); | ||
| 245 | |||
| 246 | void resetHeatRecoveryType(); | ||
| 247 | |||
| 248 | bool setSensibleHeatRecoveryEffectiveness(double sensibleHeatRecoveryEffectiveness); | ||
| 249 | |||
| 250 | void resetSensibleHeatRecoveryEffectiveness(); | ||
| 251 | |||
| 252 | bool setLatentHeatRecoveryEffectiveness(double latentHeatRecoveryEffectiveness); | ||
| 253 | |||
| 254 | void resetLatentHeatRecoveryEffectiveness(); | ||
| 255 | |||
| 256 | bool setHeatingFuelEfficiencySchedule(Schedule& heatingFuelEfficiencySchedule); | ||
| 257 | |||
| 258 | void resetHeatingFuelEfficiencySchedule(); | ||
| 259 | |||
| 260 | bool setHeatingFuelType(const std::string& heatingFuelType); | ||
| 261 | |||
| 262 | bool setCoolingFuelEfficiencySchedule(Schedule& coolingFuelEfficiencySchedule); | ||
| 263 | |||
| 264 | void resetCoolingFuelEfficiencySchedule(); | ||
| 265 | |||
| 266 | bool setCoolingFuelType(const std::string& coolingFuelType); | ||
| 267 | |||
| 268 | //@} | ||
| 269 | /** @name Other */ | ||
| 270 | //@{ | ||
| 271 | |||
| 272 | boost::optional<double> autosizedMaximumHeatingAirFlowRate() const; | ||
| 273 | |||
| 274 | boost::optional<double> autosizedMaximumSensibleHeatingCapacity() const; | ||
| 275 | |||
| 276 | boost::optional<double> autosizedMaximumCoolingAirFlowRate() const; | ||
| 277 | |||
| 278 | boost::optional<double> autosizedMaximumTotalCoolingCapacity() const; | ||
| 279 | |||
| 280 | //@} | ||
| 281 | protected: | ||
| 282 | /// @cond | ||
| 283 | using ImplType = detail::ZoneHVACIdealLoadsAirSystem_Impl; | ||
| 284 | |||
| 285 | explicit ZoneHVACIdealLoadsAirSystem(std::shared_ptr<detail::ZoneHVACIdealLoadsAirSystem_Impl> impl); | ||
| 286 | |||
| 287 | friend class detail::ZoneHVACIdealLoadsAirSystem_Impl; | ||
| 288 | friend class Model; | ||
| 289 | friend class IdfObject; | ||
| 290 | friend class openstudio::detail::IdfObject_Impl; | ||
| 291 | /// @endcond | ||
| 292 | private: | ||
| 293 | REGISTER_LOGGER("openstudio.model.ZoneHVACIdealLoadsAirSystem"); | ||
| 294 | }; | ||
| 295 | |||
| 296 | /** \relates ZoneHVACIdealLoadsAirSystem*/ | ||
| 297 | using OptionalZoneHVACIdealLoadsAirSystem = boost::optional<ZoneHVACIdealLoadsAirSystem>; | ||
| 298 | |||
| 299 | /** \relates ZoneHVACIdealLoadsAirSystem*/ | ||
| 300 | using ZoneHVACIdealLoadsAirSystemVector = std::vector<ZoneHVACIdealLoadsAirSystem>; | ||
| 301 | |||
| 302 | } // namespace model | ||
| 303 | } // namespace openstudio | ||
| 304 | |||
| 305 | #endif // MODEL_ZONEHVACIDEALLOADSAIRSYSTEM_HPP | ||
| 306 |