src/model/AirTerminalSingleDuctVAVReheat.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_AIRTERMINALSINGLEDUCTVAVREHEAT_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTVAVREHEAT_HPP | ||
| 8 | |||
| 9 | #include "ModelObject.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | #include "Connection.hpp" | ||
| 12 | #include "ModelAPI.hpp" | ||
| 13 | #include "../utilities/core/Deprecated.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | |||
| 17 | namespace model { | ||
| 18 | |||
| 19 | class Schedule; | ||
| 20 | |||
| 21 | class HVACComponent; | ||
| 22 | |||
| 23 | namespace detail { | ||
| 24 | class AirTerminalSingleDuctVAVReheat_Impl; | ||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | class MODEL_API AirTerminalSingleDuctVAVReheat : public StraightComponent | ||
| 28 | { | ||
| 29 | |||
| 30 | public: | ||
| 31 | explicit AirTerminalSingleDuctVAVReheat(const Model& model, Schedule& availabilitySchedule, HVACComponent& coil); | ||
| 32 | |||
| 33 | 583 | virtual ~AirTerminalSingleDuctVAVReheat() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | ✗ | AirTerminalSingleDuctVAVReheat(const AirTerminalSingleDuctVAVReheat& other) = default; | |
| 36 | 252 | AirTerminalSingleDuctVAVReheat(AirTerminalSingleDuctVAVReheat&& other) = default; | |
| 37 | ✗ | AirTerminalSingleDuctVAVReheat& operator=(const AirTerminalSingleDuctVAVReheat&) = default; | |
| 38 | ✗ | AirTerminalSingleDuctVAVReheat& operator=(AirTerminalSingleDuctVAVReheat&&) = default; | |
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | /** Returns the reheat coil */ | ||
| 43 | HVACComponent reheatCoil() const; | ||
| 44 | |||
| 45 | /** Sets the reheat coil. Returns true if the supplied coil was accecpted */ | ||
| 46 | bool setReheatCoil(HVACComponent& coil); | ||
| 47 | |||
| 48 | /** Returns the Schedule referred to by the AvailabilityScheduleName field. */ | ||
| 49 | Schedule availabilitySchedule() const; | ||
| 50 | |||
| 51 | /** Sets the Schedule referred to by the AvailabilityScheduleName field. */ | ||
| 52 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 53 | |||
| 54 | /** Returns the value of the MaximumAirFlowRate field. */ | ||
| 55 | boost::optional<double> maximumAirFlowRate() const; | ||
| 56 | |||
| 57 | /** Sets the value of the MaximumAirFlowRate field. */ | ||
| 58 | bool setMaximumAirFlowRate(double value); | ||
| 59 | |||
| 60 | /** Sets the value of the MaximumAirFlowRate field to AutoSize */ | ||
| 61 | void autosizeMaximumAirFlowRate(); | ||
| 62 | |||
| 63 | /** Returns true of the MaximumAirFlowRate field is set to AutoSize */ | ||
| 64 | bool isMaximumAirFlowRateAutosized() const; | ||
| 65 | |||
| 66 | /** Returns the value of the MaximumAirFlowRate field. */ | ||
| 67 | std::string zoneMinimumAirFlowInputMethod(); | ||
| 68 | /** deprecated **/ | ||
| 69 | OS_DEPRECATED(3, 0, 1) std::string zoneMinimumAirFlowMethod(); | ||
| 70 | |||
| 71 | /** Sets the value of the MaximumAirFlowRate field. | ||
| 72 | * Options are FixedFlowRate and Scheduled. | ||
| 73 | */ | ||
| 74 | bool setZoneMinimumAirFlowInputMethod(const std::string& value); | ||
| 75 | /** deprecated **/ | ||
| 76 | OS_DEPRECATED(3, 0, 1) bool setZoneMinimumAirFlowMethod(const std::string& value); | ||
| 77 | |||
| 78 | /** Returns the value of the ConstantMinimumAirFlowFraction field. */ | ||
| 79 | boost::optional<double> constantMinimumAirFlowFraction() const; | ||
| 80 | |||
| 81 | /** Sets the value of the ConstantMinimumAirFlowFraction field. */ | ||
| 82 | bool setConstantMinimumAirFlowFraction(double value); | ||
| 83 | |||
| 84 | /** Sets the value of the ConstantMinimumAirFlowFraction field to Autosize */ | ||
| 85 | void autosizeConstantMinimumAirFlowFraction(); | ||
| 86 | |||
| 87 | /** Returns true of the ConstantMinimumAirFlowFraction field is set to Autosize */ | ||
| 88 | bool isConstantMinimumAirFlowFractionAutosized() const; | ||
| 89 | |||
| 90 | /** Returns the value of the FixedMinimumAirFlowRate field. */ | ||
| 91 | boost::optional<double> fixedMinimumAirFlowRate() const; | ||
| 92 | |||
| 93 | /** Sets the value of the FixedMinimumAirFlowRate field. */ | ||
| 94 | bool setFixedMinimumAirFlowRate(double value); | ||
| 95 | |||
| 96 | /** Sets the value of the FixedMinimumAirFlowRate field to Autosize */ | ||
| 97 | void autosizeFixedMinimumAirFlowRate(); | ||
| 98 | |||
| 99 | /** Returns true of the FixedMinimumAirFlowRate field is set to Autosize */ | ||
| 100 | bool isFixedMinimumAirFlowRateAutosized() const; | ||
| 101 | |||
| 102 | /** Returns the Schedule referred to by the MinimumAirFlowFractionScheduleName field. */ | ||
| 103 | boost::optional<Schedule> minimumAirFlowFractionSchedule() const; | ||
| 104 | |||
| 105 | /** Sets the Schedule referred to by the MinimumAirFlowFractionScheduleName field. */ | ||
| 106 | bool setMinimumAirFlowFractionSchedule(Schedule& schedule); | ||
| 107 | |||
| 108 | void resetMinimumAirFlowFractionSchedule(); | ||
| 109 | |||
| 110 | /** Returns the Schedule referred to by the MinimumAirFlowTurndownScheduleName field. */ | ||
| 111 | boost::optional<Schedule> minimumAirFlowTurndownSchedule() const; | ||
| 112 | |||
| 113 | /** Sets the Schedule referred to by the MinimumAirFlowTurndownScheduleName field. */ | ||
| 114 | bool setMinimumAirFlowTurndownSchedule(Schedule& schedule); | ||
| 115 | |||
| 116 | void resetMinimumAirFlowTurndownSchedule(); | ||
| 117 | |||
| 118 | /** Returns the value of the MaximumHotWaterOrSteamFlowRate field. */ | ||
| 119 | boost::optional<double> maximumHotWaterOrSteamFlowRate(); | ||
| 120 | |||
| 121 | /** Sets the value of the MaximumHotWaterOrSteamFlowRate field. */ | ||
| 122 | bool setMaximumHotWaterOrSteamFlowRate(double value); | ||
| 123 | |||
| 124 | /** Sets the value of the MaximumHotWaterOrSteamFlowRate field to AutoSize */ | ||
| 125 | void autosizeMaximumHotWaterOrSteamFlowRate(); | ||
| 126 | |||
| 127 | /** Returns true of the MaximumHotWaterOrSteamFlowRate field is set to AutoSize */ | ||
| 128 | bool isMaximumHotWaterOrSteamFlowRateAutosized() const; | ||
| 129 | |||
| 130 | /** Returns the value of the MinimumHotWaterOrSteamFlowRate field. */ | ||
| 131 | double minimumHotWaterOrSteamFlowRate(); | ||
| 132 | |||
| 133 | /** Sets the value of the MinimumHotWaterOrSteamFlowRate field. */ | ||
| 134 | bool setMinimumHotWaterOrStreamFlowRate(double value); | ||
| 135 | |||
| 136 | /** Returns the value of the ConvergenceTolerance field. */ | ||
| 137 | double convergenceTolerance(); | ||
| 138 | |||
| 139 | /** Sets the value of the ConvergenceTolerance field. */ | ||
| 140 | bool setConvergenceTolerance(double value); | ||
| 141 | |||
| 142 | /** Returns the value of the DamperHeatingAction field. */ | ||
| 143 | std::string damperHeatingAction(); | ||
| 144 | |||
| 145 | /** Sets the value of the DamperHeatingAction field. | ||
| 146 | * Options are Normal and Reverse. | ||
| 147 | */ | ||
| 148 | bool setDamperHeatingAction(const std::string& value); | ||
| 149 | |||
| 150 | /** Returns the value of the MaximumFlowPerZoneFloorAreaDuringReheat field. */ | ||
| 151 | boost::optional<double> maximumFlowPerZoneFloorAreaDuringReheat(); | ||
| 152 | |||
| 153 | /** Sets the value of the MaximumFlowPerZoneFloorAreaDuringReheat field. */ | ||
| 154 | bool setMaximumFlowPerZoneFloorAreaDuringReheat(double value); | ||
| 155 | |||
| 156 | /** Sets the value of the MaximumFlowPerZoneFloorAreaDuringReheat field to AutoSize */ | ||
| 157 | void autosizeMaximumFlowPerZoneFloorAreaDuringReheat(); | ||
| 158 | |||
| 159 | /** Returns true of the MaximumFlowPerZoneFloorAreaDuringReheat field is set to AutoSize */ | ||
| 160 | bool isMaximumFlowPerZoneFloorAreaDuringReheatAutosized() const; | ||
| 161 | |||
| 162 | /** Resets the MaximumFlowPerZoneFloorAreaDuringReheat field to no value */ | ||
| 163 | void resetMaximumFlowPerZoneFloorAreaDuringReheat(); | ||
| 164 | |||
| 165 | /** Returns the value of the MaximumFlowFractionDuringReheat field. */ | ||
| 166 | boost::optional<double> maximumFlowFractionDuringReheat(); | ||
| 167 | |||
| 168 | /** Sets the value of the MaximumFlowFractionDuringReheat field. */ | ||
| 169 | bool setMaximumFlowFractionDuringReheat(double value); | ||
| 170 | |||
| 171 | /** Sets the value of the MaximumFlowFractionDuringReheat field to AutoSize */ | ||
| 172 | void autosizeMaximumFlowFractionDuringReheat(); | ||
| 173 | |||
| 174 | /** Returns true of the MaximumFlowFractionDuringReheat field is set to AutoSize */ | ||
| 175 | bool isMaximumFlowFractionDuringReheatAutosized() const; | ||
| 176 | |||
| 177 | /** Reset MaximumFlowFractionDuringReheat to no value */ | ||
| 178 | void resetMaximumFlowFractionDuringReheat(); | ||
| 179 | |||
| 180 | /** Returns the value of the MaximumReheatAirTemperature field. */ | ||
| 181 | double maximumReheatAirTemperature(); | ||
| 182 | |||
| 183 | /** Sets the value of the MaximumReheatAirTemperature field. */ | ||
| 184 | bool setMaximumReheatAirTemperature(double value); | ||
| 185 | |||
| 186 | /** If true, OpenStudio will attach the DesignSpecificationOutdoorAir object associated | ||
| 187 | * with the terminal's zone on export to EnergyPlus idf format. | ||
| 188 | * This field replaces the functionality of the EnergyPlus field: Design Specification Outdoor Air Object Name.*/ | ||
| 189 | bool controlForOutdoorAir() const; | ||
| 190 | |||
| 191 | bool setControlForOutdoorAir(bool controlForOutdoorAir); | ||
| 192 | |||
| 193 | boost::optional<double> autosizedMaximumAirFlowRate() const; | ||
| 194 | |||
| 195 | boost::optional<double> autosizedConstantMinimumAirFlowFraction() const; | ||
| 196 | |||
| 197 | boost::optional<double> autosizedFixedMinimumAirFlowRate() const; | ||
| 198 | |||
| 199 | boost::optional<double> autosizedMaximumHotWaterOrSteamFlowRate() const; | ||
| 200 | |||
| 201 | boost::optional<double> autosizedMaximumFlowPerZoneFloorAreaDuringReheat() const; | ||
| 202 | |||
| 203 | boost::optional<double> autosizedMaximumFlowFractionDuringReheat() const; | ||
| 204 | |||
| 205 | /** Creates a new equivalent duct object if an object is not already attached. */ | ||
| 206 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 207 | |||
| 208 | /** Returns the attached equivalent duct object, if any. */ | ||
| 209 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 210 | |||
| 211 | protected: | ||
| 212 | friend class Model; | ||
| 213 | |||
| 214 | friend class openstudio::IdfObject; | ||
| 215 | |||
| 216 | friend class openstudio::detail::IdfObject_Impl; | ||
| 217 | |||
| 218 | /// @cond | ||
| 219 | |||
| 220 | using ImplType = detail::AirTerminalSingleDuctVAVReheat_Impl; | ||
| 221 | |||
| 222 | explicit AirTerminalSingleDuctVAVReheat(std::shared_ptr<detail::AirTerminalSingleDuctVAVReheat_Impl> impl); | ||
| 223 | |||
| 224 | private: | ||
| 225 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctVAVReheat"); | |
| 226 | |||
| 227 | /// @endcond | ||
| 228 | }; | ||
| 229 | |||
| 230 | using OptionalAirTerminalSingleDuctVAVReheat = boost::optional<AirTerminalSingleDuctVAVReheat>; | ||
| 231 | |||
| 232 | } // namespace model | ||
| 233 | } // namespace openstudio | ||
| 234 | |||
| 235 | #endif // MODEL_AIRTERMINALSINGLEDUCTVAVREHEAT_HPP | ||
| 236 |