src/model/ControllerOutdoorAir.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_CONTROLLEROUTDOORAIR_HPP | ||
| 7 | #define MODEL_CONTROLLEROUTDOORAIR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject.hpp" | ||
| 11 | #include "../utilities/core/Deprecated.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class ControllerOutdoorAir_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | class Curve; | ||
| 24 | class ScheduleCompact; | ||
| 25 | class ControllerMechanicalVentilation; | ||
| 26 | class AirLoopHVACOutdoorAirSystem; | ||
| 27 | class AirflowNetworkOutdoorAirflow; | ||
| 28 | class AirflowNetworkCrack; | ||
| 29 | class ThermalZone; | ||
| 30 | |||
| 31 | class MODEL_API ControllerOutdoorAir : public ParentObject | ||
| 32 | { | ||
| 33 | public: | ||
| 34 | explicit ControllerOutdoorAir(const Model& model); | ||
| 35 | |||
| 36 | 1139 | virtual ~ControllerOutdoorAir() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | 102 | ControllerOutdoorAir(const ControllerOutdoorAir& other) = default; | |
| 39 | 140 | ControllerOutdoorAir(ControllerOutdoorAir&& other) = default; | |
| 40 | ✗ | ControllerOutdoorAir& operator=(const ControllerOutdoorAir&) = default; | |
| 41 | ✗ | ControllerOutdoorAir& operator=(ControllerOutdoorAir&&) = default; | |
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | boost::optional<Schedule> minimumOutdoorAirSchedule() const; | ||
| 46 | bool setMinimumOutdoorAirSchedule(Schedule& schedule); | ||
| 47 | void resetMinimumOutdoorAirSchedule(); | ||
| 48 | |||
| 49 | boost::optional<Schedule> minimumFractionofOutdoorAirSchedule() const; | ||
| 50 | bool setMinimumFractionofOutdoorAirSchedule(Schedule& schedule); | ||
| 51 | void resetMinimumFractionofOutdoorAirSchedule(); | ||
| 52 | |||
| 53 | boost::optional<Schedule> maximumFractionofOutdoorAirSchedule() const; | ||
| 54 | bool setMaximumFractionofOutdoorAirSchedule(Schedule& schedule); | ||
| 55 | void resetMaximumFractionofOutdoorAirSchedule(); | ||
| 56 | |||
| 57 | boost::optional<Schedule> timeofDayEconomizerControlSchedule() const; | ||
| 58 | bool setTimeofDayEconomizerControlSchedule(Schedule& schedule); | ||
| 59 | void resetTimeofDayEconomizerControlSchedule(); | ||
| 60 | |||
| 61 | boost::optional<double> minimumOutdoorAirFlowRate() const; | ||
| 62 | bool isMinimumOutdoorAirFlowRateAutosized() const; | ||
| 63 | bool setMinimumOutdoorAirFlowRate(double minimumOutdoorAirFlowRate); | ||
| 64 | void autosizeMinimumOutdoorAirFlowRate(); | ||
| 65 | |||
| 66 | boost::optional<double> maximumOutdoorAirFlowRate() const; | ||
| 67 | bool isMaximumOutdoorAirFlowRateAutosized() const; | ||
| 68 | bool setMaximumOutdoorAirFlowRate(double maximumOutdoorAirFlowRate); | ||
| 69 | void autosizeMaximumOutdoorAirFlowRate(); | ||
| 70 | |||
| 71 | ControllerMechanicalVentilation controllerMechanicalVentilation() const; | ||
| 72 | bool setControllerMechanicalVentilation(const ControllerMechanicalVentilation& controllerMechanicalVentilation); | ||
| 73 | |||
| 74 | std::string getEconomizerControlType() const; | ||
| 75 | bool setEconomizerControlType(const std::string& value); | ||
| 76 | |||
| 77 | std::string getEconomizerControlActionType() const; | ||
| 78 | bool setEconomizerControlActionType(const std::string& value); | ||
| 79 | |||
| 80 | //get needs to return a boost optional double since "" is a valid input | ||
| 81 | boost::optional<double> getEconomizerMaximumLimitDryBulbTemperature() const; | ||
| 82 | bool setEconomizerMaximumLimitDryBulbTemperature(double value); | ||
| 83 | void resetEconomizerMaximumLimitDryBulbTemperature(); | ||
| 84 | |||
| 85 | //get needs to return a boost optional double since "" is a valid input | ||
| 86 | boost::optional<double> getEconomizerMaximumLimitEnthalpy() const; | ||
| 87 | bool setEconomizerMaximumLimitEnthalpy(double value); | ||
| 88 | void resetEconomizerMaximumLimitEnthalpy(); | ||
| 89 | |||
| 90 | //get needs to return a boost optional double since "" is a valid input | ||
| 91 | boost::optional<double> getEconomizerMaximumLimitDewpointTemperature() const; | ||
| 92 | bool setEconomizerMaximumLimitDewpointTemperature(double value); | ||
| 93 | void resetEconomizerMaximumLimitDewpointTemperature(); | ||
| 94 | |||
| 95 | boost::optional<Curve> electronicEnthalpyLimitCurve() const; | ||
| 96 | bool setElectronicEnthalpyLimitCurve(const Curve& curve); | ||
| 97 | void resetElectronicEnthalpyLimitCurve(); | ||
| 98 | |||
| 99 | //get needs to return a boost optional double since "" is a valid input | ||
| 100 | boost::optional<double> getEconomizerMinimumLimitDryBulbTemperature() const; | ||
| 101 | bool setEconomizerMinimumLimitDryBulbTemperature(double value); | ||
| 102 | void resetEconomizerMinimumLimitDryBulbTemperature(); | ||
| 103 | |||
| 104 | std::string getLockoutType() const; | ||
| 105 | bool setLockoutType(const std::string& value); | ||
| 106 | |||
| 107 | std::string getMinimumLimitType() const; | ||
| 108 | bool setMinimumLimitType(const std::string& value); | ||
| 109 | |||
| 110 | boost::optional<bool> getHighHumidityControl() const; | ||
| 111 | OS_DEPRECATED(3, 8, 0) bool setHighHumidityControl(bool val); | ||
| 112 | |||
| 113 | boost::optional<ThermalZone> humidistatControlZone() const; | ||
| 114 | bool setHumidistatControlZone(const ThermalZone& thermalZone); | ||
| 115 | void resetHumidistatControlZone(); | ||
| 116 | |||
| 117 | double getHighHumidityOutdoorAirFlowRatio() const; | ||
| 118 | bool setHighHumidityOutdoorAirFlowRatio(double v); | ||
| 119 | |||
| 120 | bool getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio() const; | ||
| 121 | bool setControlHighIndoorHumidityBasedOnOutdoorHumidityRatio(bool v); | ||
| 122 | |||
| 123 | boost::optional<std::string> getHeatRecoveryBypassControlType() const; | ||
| 124 | bool setHeatRecoveryBypassControlType(const std::string& v); | ||
| 125 | |||
| 126 | std::string economizerOperationStaging() const; | ||
| 127 | bool setEconomizerOperationStaging(const std::string& v); | ||
| 128 | |||
| 129 | boost::optional<AirLoopHVACOutdoorAirSystem> airLoopHVACOutdoorAirSystem() const; | ||
| 130 | |||
| 131 | AirflowNetworkOutdoorAirflow getAirflowNetworkOutdoorAirflow(const AirflowNetworkCrack& crack); | ||
| 132 | boost::optional<AirflowNetworkOutdoorAirflow> airflowNetworkOutdoorAirflow() const; | ||
| 133 | |||
| 134 | virtual std::vector<openstudio::IdfObject> remove(); | ||
| 135 | |||
| 136 | boost::optional<double> autosizedMinimumOutdoorAirFlowRate() const; | ||
| 137 | |||
| 138 | boost::optional<double> autosizedMaximumOutdoorAirFlowRate() const; | ||
| 139 | |||
| 140 | void autosize(); | ||
| 141 | |||
| 142 | void applySizingValues(); | ||
| 143 | |||
| 144 | protected: | ||
| 145 | using ImplType = detail::ControllerOutdoorAir_Impl; | ||
| 146 | |||
| 147 | friend class Model; | ||
| 148 | |||
| 149 | friend class openstudio::IdfObject; | ||
| 150 | |||
| 151 | explicit ControllerOutdoorAir(std::shared_ptr<detail::ControllerOutdoorAir_Impl> impl); | ||
| 152 | |||
| 153 | private: | ||
| 154 | ControllerOutdoorAir(const Handle& handle, const Model& model); | ||
| 155 | |||
| 156 | − | REGISTER_LOGGER("openstudio.model.ControllerOutdoorAir"); | |
| 157 | }; | ||
| 158 | |||
| 159 | using OptionalControllerOutdoorAir = boost::optional<ControllerOutdoorAir>; | ||
| 160 | |||
| 161 | using ControllerOutdoorAirVector = std::vector<ControllerOutdoorAir>; | ||
| 162 | |||
| 163 | } // namespace model | ||
| 164 | |||
| 165 | } // namespace openstudio | ||
| 166 | |||
| 167 | #endif // MODEL_CONTROLLEROUTDOORAIR_HPP | ||
| 168 |