src/model/ZoneHVACPackagedTerminalAirConditioner_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_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_IMPL_HPP | ||
| 7 | #define MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_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 | /** ZoneHVACPackagedTerminalAirConditioner_Impl is a ZoneHVACComponent_Impl that is the implementation class for | ||
| 21 | * ZoneHVACPackagedTerminalAirConditioner. */ | ||
| 22 | class MODEL_API ZoneHVACPackagedTerminalAirConditioner_Impl : public ZoneHVACComponent_Impl | ||
| 23 | { | ||
| 24 | |||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | ZoneHVACPackagedTerminalAirConditioner_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ZoneHVACPackagedTerminalAirConditioner_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | ZoneHVACPackagedTerminalAirConditioner_Impl(const ZoneHVACPackagedTerminalAirConditioner_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 36 | virtual ~ZoneHVACPackagedTerminalAirConditioner_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual ModelObject clone(Model model) const override; | ||
| 42 | |||
| 43 | virtual std::vector<IdfObject> remove() override; | ||
| 44 | |||
| 45 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 46 | |||
| 47 | virtual IddObjectType iddObjectType() const override; | ||
| 48 | |||
| 49 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 50 | |||
| 51 | virtual std::vector<ModelObject> children() const override; | ||
| 52 | |||
| 53 | virtual unsigned inletPort() const override; | ||
| 54 | |||
| 55 | virtual unsigned outletPort() const override; | ||
| 56 | |||
| 57 | virtual ComponentType componentType() const override; | ||
| 58 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 59 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 60 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Getters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | Schedule availabilitySchedule() const; | ||
| 67 | |||
| 68 | std::string outdoorAirMixerObjectType() const; | ||
| 69 | |||
| 70 | std::string outdoorAirMixerName() const; | ||
| 71 | |||
| 72 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 73 | |||
| 74 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 75 | |||
| 76 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 77 | |||
| 78 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 79 | |||
| 80 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 81 | |||
| 82 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 83 | |||
| 84 | bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const; | ||
| 85 | |||
| 86 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 87 | |||
| 88 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 89 | |||
| 90 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 91 | |||
| 92 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 93 | |||
| 94 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 95 | |||
| 96 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 97 | |||
| 98 | HVACComponent supplyAirFan() const; | ||
| 99 | |||
| 100 | HVACComponent heatingCoil() const; | ||
| 101 | |||
| 102 | HVACComponent coolingCoil() const; | ||
| 103 | |||
| 104 | std::string fanPlacement() const; | ||
| 105 | |||
| 106 | bool isFanPlacementDefaulted() const; | ||
| 107 | |||
| 108 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 109 | |||
| 110 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 111 | |||
| 112 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 113 | |||
| 114 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 115 | |||
| 116 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 117 | |||
| 118 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 119 | |||
| 120 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 121 | |||
| 122 | virtual void autosize() override; | ||
| 123 | |||
| 124 | virtual void applySizingValues() override; | ||
| 125 | |||
| 126 | //@} | ||
| 127 | /** @name Setters */ | ||
| 128 | //@{ | ||
| 129 | |||
| 130 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 131 | |||
| 132 | bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType); | ||
| 133 | |||
| 134 | bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName); | ||
| 135 | |||
| 136 | bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation); | ||
| 137 | |||
| 138 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 139 | |||
| 140 | bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation); | ||
| 141 | |||
| 142 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 143 | |||
| 144 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 145 | |||
| 146 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 147 | |||
| 148 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 149 | |||
| 150 | bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed); | ||
| 151 | |||
| 152 | bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation); | ||
| 153 | |||
| 154 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 155 | |||
| 156 | bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation); | ||
| 157 | |||
| 158 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 159 | |||
| 160 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 161 | |||
| 162 | void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 163 | |||
| 164 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 165 | |||
| 166 | bool setSupplyAirFan(HVACComponent& fan); | ||
| 167 | |||
| 168 | bool setHeatingCoil(HVACComponent& heatingCoil); | ||
| 169 | |||
| 170 | bool setCoolingCoil(HVACComponent& coolingCoil); | ||
| 171 | |||
| 172 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 173 | |||
| 174 | void resetFanPlacement(); | ||
| 175 | |||
| 176 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 177 | |||
| 178 | //@} | ||
| 179 | /** @name Other */ | ||
| 180 | //@{ | ||
| 181 | |||
| 182 | //@} | ||
| 183 | protected: | ||
| 184 | private: | ||
| 185 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACPackagedTerminalAirConditioner"); | |
| 186 | |||
| 187 | // optional getters so can remove() if constructor fails | ||
| 188 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 189 | boost::optional<HVACComponent> optionalSupplyAirFan() const; | ||
| 190 | boost::optional<HVACComponent> optionalHeatingCoil() const; | ||
| 191 | boost::optional<HVACComponent> optionalCoolingCoil() const; | ||
| 192 | boost::optional<Schedule> optionalSupplyAirFanOperatingModeSchedule() const; | ||
| 193 | |||
| 194 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 195 | boost::optional<ModelObject> supplyAirFanAsModelObject() const; | ||
| 196 | boost::optional<ModelObject> heatingCoilAsModelObject() const; | ||
| 197 | boost::optional<ModelObject> coolingCoilAsModelObject() const; | ||
| 198 | boost::optional<ModelObject> supplyAirFanOperatingModeScheduleAsModelObject() const; | ||
| 199 | |||
| 200 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 201 | bool setSupplyAirFanAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 202 | bool setHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 203 | bool setCoolingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 204 | bool setSupplyAirFanOperatingModeScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 205 | }; | ||
| 206 | |||
| 207 | } // namespace detail | ||
| 208 | |||
| 209 | } // namespace model | ||
| 210 | } // namespace openstudio | ||
| 211 | |||
| 212 | #endif // MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_IMPL_HPP | ||
| 213 |