src/model/ZoneHVACFourPipeFanCoil_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_ZONEHVACFOURPIPEFANCOIL_IMPL_HPP | ||
| 7 | #define MODEL_ZONEHVACFOURPIPEFANCOIL_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 HVACComponent; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | /** ZoneHVACFourPipeFanCoil_Impl is a ZoneHVACComponent_Impl that is the implementation class for ZoneHVACFourPipeFanCoil.*/ | ||
| 21 | class MODEL_API ZoneHVACFourPipeFanCoil_Impl : public ZoneHVACComponent_Impl | ||
| 22 | { | ||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | ZoneHVACFourPipeFanCoil_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | ZoneHVACFourPipeFanCoil_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ZoneHVACFourPipeFanCoil_Impl(const ZoneHVACFourPipeFanCoil_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 11 | virtual ~ZoneHVACFourPipeFanCoil_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | |||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual ModelObject clone(Model model) const override; | ||
| 41 | |||
| 42 | virtual std::vector<IdfObject> remove() override; | ||
| 43 | |||
| 44 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 45 | |||
| 46 | virtual IddObjectType iddObjectType() const override; | ||
| 47 | |||
| 48 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 49 | |||
| 50 | virtual std::vector<ModelObject> children() const override; | ||
| 51 | |||
| 52 | virtual unsigned inletPort() const override; | ||
| 53 | |||
| 54 | virtual unsigned outletPort() const override; | ||
| 55 | |||
| 56 | virtual ComponentType componentType() const override; | ||
| 57 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 58 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 59 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | Schedule availabilitySchedule() const; | ||
| 66 | |||
| 67 | std::string capacityControlMethod() const; | ||
| 68 | |||
| 69 | boost::optional<double> maximumSupplyAirFlowRate() const; | ||
| 70 | |||
| 71 | bool isMaximumSupplyAirFlowRateAutosized() const; | ||
| 72 | |||
| 73 | double lowSpeedSupplyAirFlowRatio() const; | ||
| 74 | |||
| 75 | bool isLowSpeedSupplyAirFlowRatioDefaulted() const; | ||
| 76 | |||
| 77 | double mediumSpeedSupplyAirFlowRatio() const; | ||
| 78 | |||
| 79 | bool isMediumSpeedSupplyAirFlowRatioDefaulted() const; | ||
| 80 | |||
| 81 | boost::optional<double> maximumOutdoorAirFlowRate() const; | ||
| 82 | |||
| 83 | bool isMaximumOutdoorAirFlowRateAutosized() const; | ||
| 84 | |||
| 85 | boost::optional<Schedule> outdoorAirSchedule() const; | ||
| 86 | |||
| 87 | std::string outdoorAirMixerObjectType() const; | ||
| 88 | |||
| 89 | std::string outdoorAirMixerName() const; | ||
| 90 | |||
| 91 | HVACComponent supplyAirFan() const; | ||
| 92 | |||
| 93 | HVACComponent coolingCoil() const; | ||
| 94 | |||
| 95 | boost::optional<double> maximumColdWaterFlowRate() const; | ||
| 96 | |||
| 97 | bool isMaximumColdWaterFlowRateAutosized() const; | ||
| 98 | |||
| 99 | double minimumColdWaterFlowRate() const; | ||
| 100 | |||
| 101 | bool isMinimumColdWaterFlowRateDefaulted() const; | ||
| 102 | |||
| 103 | double coolingConvergenceTolerance() const; | ||
| 104 | |||
| 105 | bool isCoolingConvergenceToleranceDefaulted() const; | ||
| 106 | |||
| 107 | HVACComponent heatingCoil() const; | ||
| 108 | |||
| 109 | boost::optional<double> maximumHotWaterFlowRate() const; | ||
| 110 | |||
| 111 | bool isMaximumHotWaterFlowRateAutosized() const; | ||
| 112 | |||
| 113 | double minimumHotWaterFlowRate() const; | ||
| 114 | |||
| 115 | bool isMinimumHotWaterFlowRateDefaulted() const; | ||
| 116 | |||
| 117 | double heatingConvergenceTolerance() const; | ||
| 118 | |||
| 119 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 120 | |||
| 121 | boost::optional<double> autosizedMaximumSupplyAirFlowRate() const; | ||
| 122 | |||
| 123 | boost::optional<double> autosizedMaximumOutdoorAirFlowRate() const; | ||
| 124 | |||
| 125 | boost::optional<double> autosizedMaximumColdWaterFlowRate() const; | ||
| 126 | |||
| 127 | boost::optional<double> autosizedMaximumHotWaterFlowRate() const; | ||
| 128 | |||
| 129 | boost::optional<double> autosizedMinimumSupplyAirTemperatureinCoolingMode() const; | ||
| 130 | |||
| 131 | boost::optional<double> autosizedMaximumSupplyAirTemperatureinHeatingMode() const; | ||
| 132 | |||
| 133 | virtual void autosize() override; | ||
| 134 | |||
| 135 | virtual void applySizingValues() override; | ||
| 136 | |||
| 137 | //@} | ||
| 138 | /** @name Setters */ | ||
| 139 | //@{ | ||
| 140 | |||
| 141 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 142 | |||
| 143 | bool setCapacityControlMethod(const std::string& capacityControlMethod); | ||
| 144 | |||
| 145 | bool setMaximumSupplyAirFlowRate(boost::optional<double> maximumSupplyAirFlowRate); | ||
| 146 | |||
| 147 | void autosizeMaximumSupplyAirFlowRate(); | ||
| 148 | |||
| 149 | bool setLowSpeedSupplyAirFlowRatio(double lowSpeedSupplyAirFlowRatio); | ||
| 150 | |||
| 151 | void resetLowSpeedSupplyAirFlowRatio(); | ||
| 152 | |||
| 153 | bool setMediumSpeedSupplyAirFlowRatio(double mediumSpeedSupplyAirFlowRatio); | ||
| 154 | |||
| 155 | void resetMediumSpeedSupplyAirFlowRatio(); | ||
| 156 | |||
| 157 | bool setMaximumOutdoorAirFlowRate(boost::optional<double> maximumOutdoorAirFlowRate); | ||
| 158 | |||
| 159 | void autosizeMaximumOutdoorAirFlowRate(); | ||
| 160 | |||
| 161 | bool setOutdoorAirSchedule(Schedule& schedule); | ||
| 162 | |||
| 163 | void resetOutdoorAirSchedule(); | ||
| 164 | |||
| 165 | bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType); | ||
| 166 | |||
| 167 | bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName); | ||
| 168 | |||
| 169 | bool setSupplyAirFan(HVACComponent& fan); | ||
| 170 | |||
| 171 | bool setCoolingCoil(HVACComponent& coolingCoil); | ||
| 172 | |||
| 173 | bool setMaximumColdWaterFlowRate(boost::optional<double> maximumColdWaterFlowRate); | ||
| 174 | |||
| 175 | void autosizeMaximumColdWaterFlowRate(); | ||
| 176 | |||
| 177 | bool setMinimumColdWaterFlowRate(double minimumColdWaterFlowRate); | ||
| 178 | |||
| 179 | void resetMinimumColdWaterFlowRate(); | ||
| 180 | |||
| 181 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 182 | |||
| 183 | void resetCoolingConvergenceTolerance(); | ||
| 184 | |||
| 185 | bool setHeatingCoil(HVACComponent& heatingCoil); | ||
| 186 | |||
| 187 | bool setMaximumHotWaterFlowRate(boost::optional<double> maximumHotWaterFlowRate); | ||
| 188 | |||
| 189 | void autosizeMaximumHotWaterFlowRate(); | ||
| 190 | |||
| 191 | bool setMinimumHotWaterFlowRate(double minimumHotWaterFlowRate); | ||
| 192 | |||
| 193 | void resetMinimumHotWaterFlowRate(); | ||
| 194 | |||
| 195 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 196 | |||
| 197 | void resetHeatingConvergenceTolerance(); | ||
| 198 | |||
| 199 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 200 | |||
| 201 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 202 | |||
| 203 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 204 | |||
| 205 | boost::optional<double> minimumSupplyAirTemperatureInCoolingMode() const; | ||
| 206 | |||
| 207 | bool isMinimumSupplyAirTemperatureInCoolingModeAutosized() const; | ||
| 208 | |||
| 209 | void autosizeMinimumSupplyAirTemperatureInCoolingMode(); | ||
| 210 | |||
| 211 | bool setMinimumSupplyAirTemperatureInCoolingMode(double minimumSupplyAirTemperatureInCoolingMode); | ||
| 212 | |||
| 213 | boost::optional<double> maximumSupplyAirTemperatureInHeatingMode() const; | ||
| 214 | |||
| 215 | bool isMaximumSupplyAirTemperatureInHeatingModeAutosized() const; | ||
| 216 | |||
| 217 | void autosizeMaximumSupplyAirTemperatureInHeatingMode(); | ||
| 218 | |||
| 219 | bool setMaximumSupplyAirTemperatureInHeatingMode(double maximumSupplyAirTemperatureInHeatingMode); | ||
| 220 | |||
| 221 | //@} | ||
| 222 | /** @name Other */ | ||
| 223 | //@{ | ||
| 224 | |||
| 225 | //@} | ||
| 226 | protected: | ||
| 227 | private: | ||
| 228 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACFourPipeFanCoil"); | |
| 229 | |||
| 230 | std::vector<std::string> capacityControlMethodValues() const; | ||
| 231 | std::vector<std::string> outdoorAirMixerObjectTypeValues() const; | ||
| 232 | // optional getters so can remove() if constructor fails | ||
| 233 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 234 | boost::optional<HVACComponent> optionalSupplyAirFan() const; | ||
| 235 | boost::optional<HVACComponent> optionalHeatingCoil() const; | ||
| 236 | boost::optional<HVACComponent> optionalCoolingCoil() const; | ||
| 237 | |||
| 238 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 239 | boost::optional<ModelObject> outdoorAirScheduleAsModelObject() const; | ||
| 240 | boost::optional<ModelObject> supplyAirFanAsModelObject() const; | ||
| 241 | boost::optional<ModelObject> coolingCoilAsModelObject() const; | ||
| 242 | boost::optional<ModelObject> heatingCoilAsModelObject() const; | ||
| 243 | |||
| 244 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 245 | bool setOutdoorAirScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 246 | bool setSupplyAirFanAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 247 | bool setCoolingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 248 | bool setHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 249 | }; | ||
| 250 | |||
| 251 | } // namespace detail | ||
| 252 | |||
| 253 | } // namespace model | ||
| 254 | } // namespace openstudio | ||
| 255 | |||
| 256 | #endif // MODEL_ZONEHVACFOURPIPEFANCOIL_IMPL_HPP | ||
| 257 |