src/model/AirTerminalSingleDuctConstantVolumeReheat.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_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | #include "ModelObject.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | namespace model { | ||
| 16 | |||
| 17 | // TODO: Check the following class names against object getters and setters. | ||
| 18 | class Schedule; | ||
| 19 | class HVACComponent; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class AirTerminalSingleDuctConstantVolumeReheat_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** AirTerminalSingleDuctConstantVolumeReheat is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirTerminal:SingleDuct:ConstantVolume:Reheat'. */ | ||
| 28 | class MODEL_API AirTerminalSingleDuctConstantVolumeReheat : public StraightComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit AirTerminalSingleDuctConstantVolumeReheat(const Model& model, Schedule& availabilitySchedule, HVACComponent& coil); | ||
| 35 | |||
| 36 | 63 | virtual ~AirTerminalSingleDuctConstantVolumeReheat() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | ✗ | AirTerminalSingleDuctConstantVolumeReheat(const AirTerminalSingleDuctConstantVolumeReheat& other) = default; | |
| 39 | 12 | AirTerminalSingleDuctConstantVolumeReheat(AirTerminalSingleDuctConstantVolumeReheat&& other) = default; | |
| 40 | ✗ | AirTerminalSingleDuctConstantVolumeReheat& operator=(const AirTerminalSingleDuctConstantVolumeReheat&) = default; | |
| 41 | ✗ | AirTerminalSingleDuctConstantVolumeReheat& operator=(AirTerminalSingleDuctConstantVolumeReheat&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | // TODO: Check return type. From object lists, some candidates are: Schedule. | ||
| 51 | Schedule availabilitySchedule() const; | ||
| 52 | |||
| 53 | boost::optional<double> maximumAirFlowRate() const; | ||
| 54 | |||
| 55 | bool isMaximumAirFlowRateAutosized() const; | ||
| 56 | |||
| 57 | // TODO: Check return type. From object lists, some candidates are: HeatingCoilName. | ||
| 58 | HVACComponent reheatCoil() const; | ||
| 59 | |||
| 60 | boost::optional<double> maximumHotWaterorSteamFlowRate() const; | ||
| 61 | |||
| 62 | bool isMaximumHotWaterorSteamFlowRateAutosized() const; | ||
| 63 | |||
| 64 | double minimumHotWaterorSteamFlowRate() const; | ||
| 65 | |||
| 66 | bool isMinimumHotWaterorSteamFlowRateDefaulted() const; | ||
| 67 | |||
| 68 | double convergenceTolerance() const; | ||
| 69 | |||
| 70 | bool isConvergenceToleranceDefaulted() const; | ||
| 71 | |||
| 72 | double maximumReheatAirTemperature() const; | ||
| 73 | |||
| 74 | bool isMaximumReheatAirTemperatureDefaulted() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | // TODO: Check argument type. From object lists, some candidates are: Schedule. | ||
| 81 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 82 | |||
| 83 | bool setMaximumAirFlowRate(double maximumAirFlowRate); | ||
| 84 | |||
| 85 | void resetMaximumAirFlowRate(); | ||
| 86 | |||
| 87 | void autosizeMaximumAirFlowRate(); | ||
| 88 | |||
| 89 | // TODO: Check argument type. From object lists, some candidates are: HeatingCoilName. | ||
| 90 | bool setReheatCoil(const HVACComponent& coil); | ||
| 91 | |||
| 92 | void resetReheatCoil(); | ||
| 93 | |||
| 94 | bool setMaximumHotWaterorSteamFlowRate(double maximumHotWaterorSteamFlowRate); | ||
| 95 | |||
| 96 | void resetMaximumHotWaterorSteamFlowRate(); | ||
| 97 | |||
| 98 | void autosizeMaximumHotWaterorSteamFlowRate(); | ||
| 99 | |||
| 100 | bool setMinimumHotWaterorSteamFlowRate(double minimumHotWaterorSteamFlowRate); | ||
| 101 | |||
| 102 | void resetMinimumHotWaterorSteamFlowRate(); | ||
| 103 | |||
| 104 | bool setConvergenceTolerance(double convergenceTolerance); | ||
| 105 | |||
| 106 | void resetConvergenceTolerance(); | ||
| 107 | |||
| 108 | bool setMaximumReheatAirTemperature(double maximumReheatAirTemperature); | ||
| 109 | |||
| 110 | void resetMaximumReheatAirTemperature(); | ||
| 111 | |||
| 112 | //@} | ||
| 113 | /** @name Other */ | ||
| 114 | //@{ | ||
| 115 | |||
| 116 | /** Creates a new equivalent duct object if an object is not already attached. */ | ||
| 117 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 118 | |||
| 119 | /** Returns the attached equivalent duct object, if any. */ | ||
| 120 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 121 | |||
| 122 | boost::optional<double> autosizedMaximumAirFlowRate() const; | ||
| 123 | |||
| 124 | boost::optional<double> autosizedMaximumHotWaterorSteamFlowRate() const; | ||
| 125 | |||
| 126 | //@} | ||
| 127 | protected: | ||
| 128 | /// @cond | ||
| 129 | using ImplType = detail::AirTerminalSingleDuctConstantVolumeReheat_Impl; | ||
| 130 | |||
| 131 | explicit AirTerminalSingleDuctConstantVolumeReheat(std::shared_ptr<detail::AirTerminalSingleDuctConstantVolumeReheat_Impl> impl); | ||
| 132 | |||
| 133 | friend class detail::AirTerminalSingleDuctConstantVolumeReheat_Impl; | ||
| 134 | friend class Model; | ||
| 135 | friend class openstudio::IdfObject; | ||
| 136 | friend class openstudio::detail::IdfObject_Impl; | ||
| 137 | /// @endcond | ||
| 138 | private: | ||
| 139 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeReheat"); | |
| 140 | }; | ||
| 141 | |||
| 142 | /** \relates AirTerminalSingleDuctConstantVolumeReheat*/ | ||
| 143 | using OptionalAirTerminalSingleDuctConstantVolumeReheat = boost::optional<AirTerminalSingleDuctConstantVolumeReheat>; | ||
| 144 | |||
| 145 | /** \relates AirTerminalSingleDuctConstantVolumeReheat*/ | ||
| 146 | using AirTerminalSingleDuctConstantVolumeReheatVector = std::vector<AirTerminalSingleDuctConstantVolumeReheat>; | ||
| 147 | |||
| 148 | } // namespace model | ||
| 149 | } // namespace openstudio | ||
| 150 | |||
| 151 | #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_HPP | ||
| 152 |