src/model/ZoneVentilationWindandStackOpenArea.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_ZONEVENTILATIONWINDANDSTACKOPENAREA_HPP | ||
| 7 | #define MODEL_ZONEVENTILATIONWINDANDSTACKOPENAREA_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class ZoneVentilationWindandStackOpenArea_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** ZoneVentilationWindandStackOpenArea is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneVentilation:WindandStackOpenArea'. */ | ||
| 25 | class MODEL_API ZoneVentilationWindandStackOpenArea : public ZoneHVACComponent | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit ZoneVentilationWindandStackOpenArea(const Model& model); | ||
| 32 | |||
| 33 | 13 | virtual ~ZoneVentilationWindandStackOpenArea() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | 1 | ZoneVentilationWindandStackOpenArea(const ZoneVentilationWindandStackOpenArea& other) = default; | |
| 36 | 2 | ZoneVentilationWindandStackOpenArea(ZoneVentilationWindandStackOpenArea&& other) = default; | |
| 37 | ✗ | ZoneVentilationWindandStackOpenArea& operator=(const ZoneVentilationWindandStackOpenArea&) = default; | |
| 38 | ✗ | ZoneVentilationWindandStackOpenArea& operator=(ZoneVentilationWindandStackOpenArea&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | double openingArea() const; | ||
| 48 | |||
| 49 | Schedule openingAreaFractionSchedule() const; | ||
| 50 | |||
| 51 | boost::optional<double> openingEffectiveness() const; | ||
| 52 | bool isOpeningEffectivenessAutocalculated() const; | ||
| 53 | |||
| 54 | double effectiveAngle() const; | ||
| 55 | |||
| 56 | double heightDifference() const; | ||
| 57 | |||
| 58 | boost::optional<double> dischargeCoefficientforOpening() const; | ||
| 59 | bool isDischargeCoefficientforOpeningAutocalculated() const; | ||
| 60 | |||
| 61 | double minimumIndoorTemperature() const; | ||
| 62 | |||
| 63 | boost::optional<Schedule> minimumIndoorTemperatureSchedule() const; | ||
| 64 | |||
| 65 | double maximumIndoorTemperature() const; | ||
| 66 | |||
| 67 | boost::optional<Schedule> maximumIndoorTemperatureSchedule() const; | ||
| 68 | |||
| 69 | double deltaTemperature() const; | ||
| 70 | |||
| 71 | boost::optional<Schedule> deltaTemperatureSchedule() const; | ||
| 72 | |||
| 73 | double minimumOutdoorTemperature() const; | ||
| 74 | |||
| 75 | boost::optional<Schedule> minimumOutdoorTemperatureSchedule() const; | ||
| 76 | |||
| 77 | double maximumOutdoorTemperature() const; | ||
| 78 | |||
| 79 | boost::optional<Schedule> maximumOutdoorTemperatureSchedule() const; | ||
| 80 | |||
| 81 | double maximumWindSpeed() const; | ||
| 82 | |||
| 83 | //@} | ||
| 84 | /** @name Setters */ | ||
| 85 | //@{ | ||
| 86 | |||
| 87 | bool setOpeningArea(double openingArea); | ||
| 88 | |||
| 89 | bool setOpeningAreaFractionSchedule(Schedule& schedule); | ||
| 90 | |||
| 91 | bool setOpeningEffectiveness(double openingEffectiveness); | ||
| 92 | void autocalculateOpeningEffectiveness(); | ||
| 93 | |||
| 94 | bool setEffectiveAngle(double effectiveAngle); | ||
| 95 | |||
| 96 | bool setHeightDifference(double heightDifference); | ||
| 97 | |||
| 98 | bool setDischargeCoefficientforOpening(double dischargeCoefficientforOpening); | ||
| 99 | void autocalculateDischargeCoefficientforOpening(); | ||
| 100 | |||
| 101 | bool setMinimumIndoorTemperature(double minimumIndoorTemperature); | ||
| 102 | |||
| 103 | bool setMinimumIndoorTemperatureSchedule(Schedule& schedule); | ||
| 104 | void resetMinimumIndoorTemperatureSchedule(); | ||
| 105 | |||
| 106 | bool setMaximumIndoorTemperature(double maximumIndoorTemperature); | ||
| 107 | |||
| 108 | bool setMaximumIndoorTemperatureSchedule(Schedule& schedule); | ||
| 109 | void resetMaximumIndoorTemperatureSchedule(); | ||
| 110 | |||
| 111 | bool setDeltaTemperature(double deltaTemperature); | ||
| 112 | |||
| 113 | bool setDeltaTemperatureSchedule(Schedule& schedule); | ||
| 114 | void resetDeltaTemperatureSchedule(); | ||
| 115 | |||
| 116 | bool setMinimumOutdoorTemperature(double minimumOutdoorTemperature); | ||
| 117 | |||
| 118 | bool setMinimumOutdoorTemperatureSchedule(Schedule& schedule); | ||
| 119 | void resetMinimumOutdoorTemperatureSchedule(); | ||
| 120 | |||
| 121 | bool setMaximumOutdoorTemperature(double maximumOutdoorTemperature); | ||
| 122 | |||
| 123 | bool setMaximumOutdoorTemperatureSchedule(Schedule& schedule); | ||
| 124 | void resetMaximumOutdoorTemperatureSchedule(); | ||
| 125 | |||
| 126 | bool setMaximumWindSpeed(double maximumWindSpeed); | ||
| 127 | |||
| 128 | //@} | ||
| 129 | /** @name Other */ | ||
| 130 | //@{ | ||
| 131 | |||
| 132 | //@} | ||
| 133 | protected: | ||
| 134 | /// @cond | ||
| 135 | using ImplType = detail::ZoneVentilationWindandStackOpenArea_Impl; | ||
| 136 | |||
| 137 | explicit ZoneVentilationWindandStackOpenArea(std::shared_ptr<detail::ZoneVentilationWindandStackOpenArea_Impl> impl); | ||
| 138 | |||
| 139 | friend class detail::ZoneVentilationWindandStackOpenArea_Impl; | ||
| 140 | friend class Model; | ||
| 141 | friend class IdfObject; | ||
| 142 | friend class openstudio::detail::IdfObject_Impl; | ||
| 143 | /// @endcond | ||
| 144 | private: | ||
| 145 | REGISTER_LOGGER("openstudio.model.ZoneVentilationWindandStackOpenArea"); | ||
| 146 | }; | ||
| 147 | |||
| 148 | /** \relates ZoneVentilationWindandStackOpenArea*/ | ||
| 149 | using OptionalZoneVentilationWindandStackOpenArea = boost::optional<ZoneVentilationWindandStackOpenArea>; | ||
| 150 | |||
| 151 | /** \relates ZoneVentilationWindandStackOpenArea*/ | ||
| 152 | using ZoneVentilationWindandStackOpenAreaVector = std::vector<ZoneVentilationWindandStackOpenArea>; | ||
| 153 | |||
| 154 | } // namespace model | ||
| 155 | } // namespace openstudio | ||
| 156 | |||
| 157 | #endif // MODEL_ZONEVENTILATIONWINDANDSTACKOPENAREA_HPP | ||
| 158 |