src/model/ZoneHVACUnitVentilator.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_ZONEHVACUNITVENTILATOR_HPP | ||
| 7 | #define MODEL_ZONEHVACUNITVENTILATOR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class HVACComponent; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACUnitVentilator_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACUnitVentilator is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:UnitVentilator'. */ | ||
| 26 | class MODEL_API ZoneHVACUnitVentilator : public ZoneHVACComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit ZoneHVACUnitVentilator(const Model& model); | ||
| 33 | |||
| 34 | explicit ZoneHVACUnitVentilator(const Model& model, const HVACComponent& supplyAirFan); | ||
| 35 | |||
| 36 | 23 | virtual ~ZoneHVACUnitVentilator() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | ✗ | ZoneHVACUnitVentilator(const ZoneHVACUnitVentilator& other) = default; | |
| 39 | 1 | ZoneHVACUnitVentilator(ZoneHVACUnitVentilator&& other) = default; | |
| 40 | ✗ | ZoneHVACUnitVentilator& operator=(const ZoneHVACUnitVentilator&) = default; | |
| 41 | ✗ | ZoneHVACUnitVentilator& operator=(ZoneHVACUnitVentilator&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | static std::vector<std::string> outdoorAirControlTypeValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | Schedule availabilitySchedule() const; | ||
| 53 | |||
| 54 | boost::optional<double> maximumSupplyAirFlowRate() const; | ||
| 55 | |||
| 56 | bool isMaximumSupplyAirFlowRateAutosized() const; | ||
| 57 | |||
| 58 | std::string outdoorAirControlType() const; | ||
| 59 | |||
| 60 | boost::optional<double> minimumOutdoorAirFlowRate() const; | ||
| 61 | |||
| 62 | bool isMinimumOutdoorAirFlowRateAutosized() const; | ||
| 63 | |||
| 64 | Schedule minimumOutdoorAirSchedule() const; | ||
| 65 | |||
| 66 | boost::optional<double> maximumOutdoorAirFlowRate() const; | ||
| 67 | |||
| 68 | bool isMaximumOutdoorAirFlowRateAutosized() const; | ||
| 69 | |||
| 70 | Schedule maximumOutdoorAirFractionorTemperatureSchedule() const; | ||
| 71 | |||
| 72 | HVACComponent supplyAirFan() const; | ||
| 73 | |||
| 74 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 75 | |||
| 76 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 77 | |||
| 78 | double heatingConvergenceTolerance() const; | ||
| 79 | |||
| 80 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 81 | |||
| 82 | double coolingConvergenceTolerance() const; | ||
| 83 | |||
| 84 | // boost::optional<ModelObject> availabilityManagerList() const; | ||
| 85 | |||
| 86 | // boost::optional<ModelObject> designSpecificationZoneHVACSizingObject() const; | ||
| 87 | |||
| 88 | //@} | ||
| 89 | /** @name Setters */ | ||
| 90 | //@{ | ||
| 91 | |||
| 92 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 93 | |||
| 94 | bool setMaximumSupplyAirFlowRate(double maximumSupplyAirFlowRate); | ||
| 95 | |||
| 96 | void autosizeMaximumSupplyAirFlowRate(); | ||
| 97 | |||
| 98 | bool setOutdoorAirControlType(const std::string& outdoorAirControlType); | ||
| 99 | |||
| 100 | bool setMinimumOutdoorAirFlowRate(double minimumOutdoorAirFlowRate); | ||
| 101 | |||
| 102 | void autosizeMinimumOutdoorAirFlowRate(); | ||
| 103 | |||
| 104 | bool setMinimumOutdoorAirSchedule(Schedule& schedule); | ||
| 105 | |||
| 106 | bool setMaximumOutdoorAirFlowRate(double maximumOutdoorAirFlowRate); | ||
| 107 | |||
| 108 | void autosizeMaximumOutdoorAirFlowRate(); | ||
| 109 | |||
| 110 | bool setMaximumOutdoorAirFractionorTemperatureSchedule(Schedule& schedule); | ||
| 111 | |||
| 112 | bool setSupplyAirFan(const HVACComponent& supplyAirFan); | ||
| 113 | |||
| 114 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 115 | |||
| 116 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 117 | |||
| 118 | bool setHeatingCoil(const HVACComponent& heatingCoil); | ||
| 119 | |||
| 120 | void resetHeatingCoil(); | ||
| 121 | |||
| 122 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 123 | |||
| 124 | bool setCoolingCoil(const HVACComponent& coolingCoil); | ||
| 125 | |||
| 126 | void resetCoolingCoil(); | ||
| 127 | |||
| 128 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 129 | |||
| 130 | // bool setAvailabilityManagerList(const ModelObject& systemAvailabilityManagerLists); | ||
| 131 | |||
| 132 | // void resetAvailabilityManagerList(); | ||
| 133 | |||
| 134 | // bool setDesignSpecificationZoneHVACSizingObject(const ModelObject& designSpecificationZoneHVACSizingName); | ||
| 135 | |||
| 136 | // void resetDesignSpecificationZoneHVACSizingObject(); | ||
| 137 | |||
| 138 | //@} | ||
| 139 | /** @name Other */ | ||
| 140 | //@{ | ||
| 141 | |||
| 142 | boost::optional<double> autosizedMaximumSupplyAirFlowRate() const; | ||
| 143 | |||
| 144 | boost::optional<double> autosizedMinimumOutdoorAirFlowRate() const; | ||
| 145 | |||
| 146 | boost::optional<double> autosizedMaximumOutdoorAirFlowRate() const; | ||
| 147 | |||
| 148 | //@} | ||
| 149 | protected: | ||
| 150 | /// @cond | ||
| 151 | using ImplType = detail::ZoneHVACUnitVentilator_Impl; | ||
| 152 | |||
| 153 | explicit ZoneHVACUnitVentilator(std::shared_ptr<detail::ZoneHVACUnitVentilator_Impl> impl); | ||
| 154 | |||
| 155 | friend class detail::ZoneHVACUnitVentilator_Impl; | ||
| 156 | friend class Model; | ||
| 157 | friend class IdfObject; | ||
| 158 | friend class openstudio::detail::IdfObject_Impl; | ||
| 159 | /// @endcond | ||
| 160 | private: | ||
| 161 | REGISTER_LOGGER("openstudio.model.ZoneHVACUnitVentilator"); | ||
| 162 | }; | ||
| 163 | |||
| 164 | /** \relates ZoneHVACUnitVentilator*/ | ||
| 165 | using OptionalZoneHVACUnitVentilator = boost::optional<ZoneHVACUnitVentilator>; | ||
| 166 | |||
| 167 | /** \relates ZoneHVACUnitVentilator*/ | ||
| 168 | using ZoneHVACUnitVentilatorVector = std::vector<ZoneHVACUnitVentilator>; | ||
| 169 | |||
| 170 | } // namespace model | ||
| 171 | } // namespace openstudio | ||
| 172 | |||
| 173 | #endif // MODEL_ZONEHVACUNITVENTILATOR_HPP | ||
| 174 |