src/model/FanZoneExhaust.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_FANZONEEXHAUST_HPP | ||
| 7 | #define MODEL_FANZONEEXHAUST_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class AirflowNetworkZoneExhaustFan; | ||
| 18 | class AirflowNetworkCrack; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class FanZoneExhaust_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** FanZoneExhaust is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:Fan:ZoneExhaust'. */ | ||
| 27 | class MODEL_API FanZoneExhaust : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit FanZoneExhaust(const Model& model); | ||
| 34 | |||
| 35 | 5 | virtual ~FanZoneExhaust() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | FanZoneExhaust(const FanZoneExhaust& other) = default; | |
| 38 | ✗ | FanZoneExhaust(FanZoneExhaust&& other) = default; | |
| 39 | ✗ | FanZoneExhaust& operator=(const FanZoneExhaust&) = default; | |
| 40 | ✗ | FanZoneExhaust& operator=(FanZoneExhaust&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> systemAvailabilityManagerCouplingModeValues(); | ||
| 47 | |||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 52 | |||
| 53 | double fanTotalEfficiency() const; | ||
| 54 | |||
| 55 | /** Deprecated, forwards to fanTotalEfficiency */ | ||
| 56 | double fanEfficiency() const; | ||
| 57 | |||
| 58 | double pressureRise() const; | ||
| 59 | |||
| 60 | boost::optional<double> maximumFlowRate() const; | ||
| 61 | |||
| 62 | std::string endUseSubcategory() const; | ||
| 63 | |||
| 64 | boost::optional<Schedule> flowFractionSchedule() const; | ||
| 65 | |||
| 66 | std::string systemAvailabilityManagerCouplingMode() const; | ||
| 67 | |||
| 68 | boost::optional<Schedule> minimumZoneTemperatureLimitSchedule() const; | ||
| 69 | |||
| 70 | boost::optional<Schedule> balancedExhaustFractionSchedule() const; | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Setters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 77 | |||
| 78 | void resetAvailabilitySchedule(); | ||
| 79 | |||
| 80 | bool setFanTotalEfficiency(double fanTotalEfficiency); | ||
| 81 | |||
| 82 | /** Deprecated, forwards to setFanTotalEfficiency */ | ||
| 83 | bool setFanEfficiency(double fanTotalEfficiency); | ||
| 84 | |||
| 85 | bool setPressureRise(double pressureRise); | ||
| 86 | |||
| 87 | bool setMaximumFlowRate(double maximumFlowRate); | ||
| 88 | |||
| 89 | void resetMaximumFlowRate(); | ||
| 90 | |||
| 91 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 92 | |||
| 93 | bool setFlowFractionSchedule(Schedule& schedule); | ||
| 94 | |||
| 95 | void resetFlowFractionSchedule(); | ||
| 96 | |||
| 97 | bool setSystemAvailabilityManagerCouplingMode(const std::string& systemAvailabilityManagerCouplingMode); | ||
| 98 | |||
| 99 | bool setMinimumZoneTemperatureLimitSchedule(Schedule& schedule); | ||
| 100 | |||
| 101 | void resetMinimumZoneTemperatureLimitSchedule(); | ||
| 102 | |||
| 103 | bool setBalancedExhaustFractionSchedule(Schedule& schedule); | ||
| 104 | |||
| 105 | void resetBalancedExhaustFractionSchedule(); | ||
| 106 | |||
| 107 | //@} | ||
| 108 | /** @name Other */ | ||
| 109 | //@{ | ||
| 110 | |||
| 111 | AirflowNetworkZoneExhaustFan getAirflowNetworkZoneExhaustFan(const AirflowNetworkCrack& crack); | ||
| 112 | boost::optional<AirflowNetworkZoneExhaustFan> airflowNetworkZoneExhaustFan() const; | ||
| 113 | |||
| 114 | //@} | ||
| 115 | protected: | ||
| 116 | /// @cond | ||
| 117 | using ImplType = detail::FanZoneExhaust_Impl; | ||
| 118 | |||
| 119 | explicit FanZoneExhaust(std::shared_ptr<detail::FanZoneExhaust_Impl> impl); | ||
| 120 | |||
| 121 | friend class detail::FanZoneExhaust_Impl; | ||
| 122 | friend class Model; | ||
| 123 | friend class IdfObject; | ||
| 124 | friend class openstudio::detail::IdfObject_Impl; | ||
| 125 | /// @endcond | ||
| 126 | private: | ||
| 127 | REGISTER_LOGGER("openstudio.model.FanZoneExhaust"); | ||
| 128 | }; | ||
| 129 | |||
| 130 | /** \relates FanZoneExhaust*/ | ||
| 131 | using OptionalFanZoneExhaust = boost::optional<FanZoneExhaust>; | ||
| 132 | |||
| 133 | /** \relates FanZoneExhaust*/ | ||
| 134 | using FanZoneExhaustVector = std::vector<FanZoneExhaust>; | ||
| 135 | |||
| 136 | } // namespace model | ||
| 137 | } // namespace openstudio | ||
| 138 | |||
| 139 | #endif // MODEL_FANZONEEXHAUST_HPP | ||
| 140 |