src/model/ZoneHVACEnergyRecoveryVentilatorController.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_ZONEHVACENERGYRECOVERYVENTILATORCONTROLLER_HPP | ||
| 7 | #define MODEL_ZONEHVACENERGYRECOVERYVENTILATORCONTROLLER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Curve; | ||
| 17 | class Schedule; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACEnergyRecoveryVentilatorController_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACEnergyRecoveryVentilatorController is a ParentObject that wraps the OpenStudio IDD object 'OS:ZoneHVAC:EnergyRecoveryVentilator:Controller'. */ | ||
| 26 | class MODEL_API ZoneHVACEnergyRecoveryVentilatorController : public ParentObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit ZoneHVACEnergyRecoveryVentilatorController(const Model& model); | ||
| 33 | |||
| 34 | ✗ | virtual ~ZoneHVACEnergyRecoveryVentilatorController() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | ZoneHVACEnergyRecoveryVentilatorController(const ZoneHVACEnergyRecoveryVentilatorController& other) = default; | |
| 37 | ✗ | ZoneHVACEnergyRecoveryVentilatorController(ZoneHVACEnergyRecoveryVentilatorController&& other) = default; | |
| 38 | ✗ | ZoneHVACEnergyRecoveryVentilatorController& operator=(const ZoneHVACEnergyRecoveryVentilatorController&) = default; | |
| 39 | ✗ | ZoneHVACEnergyRecoveryVentilatorController& operator=(ZoneHVACEnergyRecoveryVentilatorController&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> exhaustAirTemperatureLimitValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> exhaustAirEnthalpyLimitValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | boost::optional<double> temperatureHighLimit() const; | ||
| 53 | |||
| 54 | boost::optional<double> temperatureLowLimit() const; | ||
| 55 | |||
| 56 | boost::optional<double> enthalpyHighLimit() const; | ||
| 57 | |||
| 58 | boost::optional<double> dewpointTemperatureLimit() const; | ||
| 59 | |||
| 60 | boost::optional<Curve> electronicEnthalpyLimitCurve() const; | ||
| 61 | |||
| 62 | std::string exhaustAirTemperatureLimit() const; | ||
| 63 | |||
| 64 | std::string exhaustAirEnthalpyLimit() const; | ||
| 65 | |||
| 66 | boost::optional<Schedule> timeofDayEconomizerFlowControlSchedule() const; | ||
| 67 | |||
| 68 | bool highHumidityControlFlag() const; | ||
| 69 | |||
| 70 | double highHumidityOutdoorAirFlowRatio() const; | ||
| 71 | |||
| 72 | bool controlHighIndoorHumidityBasedonOutdoorHumidityRatio() const; | ||
| 73 | |||
| 74 | //@} | ||
| 75 | /** @name Setters */ | ||
| 76 | //@{ | ||
| 77 | |||
| 78 | bool setTemperatureHighLimit(double temperatureHighLimit); | ||
| 79 | |||
| 80 | void resetTemperatureHighLimit(); | ||
| 81 | |||
| 82 | bool setTemperatureLowLimit(double temperatureLowLimit); | ||
| 83 | |||
| 84 | void resetTemperatureLowLimit(); | ||
| 85 | |||
| 86 | bool setEnthalpyHighLimit(double enthalpyHighLimit); | ||
| 87 | |||
| 88 | void resetEnthalpyHighLimit(); | ||
| 89 | |||
| 90 | bool setDewpointTemperatureLimit(double dewpointTemperatureLimit); | ||
| 91 | |||
| 92 | void resetDewpointTemperatureLimit(); | ||
| 93 | |||
| 94 | bool setElectronicEnthalpyLimitCurve(const Curve& curve); | ||
| 95 | |||
| 96 | void resetElectronicEnthalpyLimitCurve(); | ||
| 97 | |||
| 98 | bool setExhaustAirTemperatureLimit(const std::string& exhaustAirTemperatureLimit); | ||
| 99 | |||
| 100 | bool setExhaustAirEnthalpyLimit(const std::string& exhaustAirEnthalpyLimit); | ||
| 101 | |||
| 102 | bool setTimeofDayEconomizerFlowControlSchedule(Schedule& schedule); | ||
| 103 | |||
| 104 | void resetTimeofDayEconomizerFlowControlSchedule(); | ||
| 105 | |||
| 106 | bool setHighHumidityControlFlag(bool highHumidityControlFlag); | ||
| 107 | |||
| 108 | bool setHighHumidityOutdoorAirFlowRatio(double highHumidityOutdoorAirFlowRatio); | ||
| 109 | |||
| 110 | bool setControlHighIndoorHumidityBasedonOutdoorHumidityRatio(bool controlHighIndoorHumidityBasedonOutdoorHumidityRatio); | ||
| 111 | |||
| 112 | //@} | ||
| 113 | /** @name Other */ | ||
| 114 | //@{ | ||
| 115 | |||
| 116 | //@} | ||
| 117 | protected: | ||
| 118 | /// @cond | ||
| 119 | using ImplType = detail::ZoneHVACEnergyRecoveryVentilatorController_Impl; | ||
| 120 | |||
| 121 | explicit ZoneHVACEnergyRecoveryVentilatorController(std::shared_ptr<detail::ZoneHVACEnergyRecoveryVentilatorController_Impl> impl); | ||
| 122 | |||
| 123 | friend class detail::ZoneHVACEnergyRecoveryVentilatorController_Impl; | ||
| 124 | friend class Model; | ||
| 125 | friend class IdfObject; | ||
| 126 | friend class openstudio::detail::IdfObject_Impl; | ||
| 127 | /// @endcond | ||
| 128 | private: | ||
| 129 | REGISTER_LOGGER("openstudio.model.ZoneHVACEnergyRecoveryVentilatorController"); | ||
| 130 | }; | ||
| 131 | |||
| 132 | /** \relates ZoneHVACEnergyRecoveryVentilatorController*/ | ||
| 133 | using OptionalZoneHVACEnergyRecoveryVentilatorController = boost::optional<ZoneHVACEnergyRecoveryVentilatorController>; | ||
| 134 | |||
| 135 | /** \relates ZoneHVACEnergyRecoveryVentilatorController*/ | ||
| 136 | using ZoneHVACEnergyRecoveryVentilatorControllerVector = std::vector<ZoneHVACEnergyRecoveryVentilatorController>; | ||
| 137 | |||
| 138 | } // namespace model | ||
| 139 | } // namespace openstudio | ||
| 140 | |||
| 141 | #endif // MODEL_ZONEHVACENERGYRECOVERYVENTILATORCONTROLLER_HPP | ||
| 142 |