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