src/model/AirTerminalDualDuctConstantVolume.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_AIRTERMINALDUALDUCTCONSTANTVOLUME_HPP | ||
| 7 | #define MODEL_AIRTERMINALDUALDUCTCONSTANTVOLUME_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Mixer.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Node; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class AirTerminalDualDuctConstantVolume_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** AirTerminalDualDuctConstantVolume is a Mixer that wraps the OpenStudio IDD object 'OS:AirTerminal:DualDuct:ConstantVolume'. */ | ||
| 26 | class MODEL_API AirTerminalDualDuctConstantVolume : public Mixer | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit AirTerminalDualDuctConstantVolume(const Model& model); | ||
| 33 | |||
| 34 | 28 | virtual ~AirTerminalDualDuctConstantVolume() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 2 | AirTerminalDualDuctConstantVolume(const AirTerminalDualDuctConstantVolume& other) = default; | |
| 37 | 3 | AirTerminalDualDuctConstantVolume(AirTerminalDualDuctConstantVolume&& other) = default; | |
| 38 | ✗ | AirTerminalDualDuctConstantVolume& operator=(const AirTerminalDualDuctConstantVolume&) = default; | |
| 39 | ✗ | AirTerminalDualDuctConstantVolume& operator=(AirTerminalDualDuctConstantVolume&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | /** @name Getters */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | Schedule availabilitySchedule() const; | ||
| 49 | |||
| 50 | boost::optional<double> maximumAirFlowRate() const; | ||
| 51 | |||
| 52 | bool isMaximumAirFlowRateAutosized() const; | ||
| 53 | |||
| 54 | //@} | ||
| 55 | /** @name Setters */ | ||
| 56 | //@{ | ||
| 57 | |||
| 58 | // Note Schedules are passed by reference, not const reference. | ||
| 59 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 60 | |||
| 61 | bool setMaximumAirFlowRate(double maximumAirFlowRate); | ||
| 62 | |||
| 63 | void autosizeMaximumAirFlowRate(); | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Other */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | /** This corresponds to Mixer::inletModelObject(0), as well as the system's branch 0 | ||
| 70 | * (ie. AirLoopHVAC::demandInletNodes()[0] and AirLoopHVAC::supplyOutletNodes()[0]) | ||
| 71 | * In OpenStudio we avoid using hot / cold nomenclature in the dual duct system api, | ||
| 72 | * but here in the terminal interface we use the language for transparency with the idf. | ||
| 73 | */ | ||
| 74 | boost::optional<Node> hotAirInletNode() const; | ||
| 75 | |||
| 76 | /** This corresponds to Mixer::inletModelObject(1), as well as the system's branch 1 | ||
| 77 | * (ie. AirLoopHVAC::demandInletNodes()[1] and AirLoopHVAC::supplyOutletNodes()[1]) | ||
| 78 | */ | ||
| 79 | boost::optional<Node> coldAirInletNode() const; | ||
| 80 | |||
| 81 | /* Queries the autosized maximum terminal air flow rate from the SQL file */ | ||
| 82 | boost::optional<double> autosizedMaximumAirFlowRate() const; | ||
| 83 | |||
| 84 | /* Autosize all autosizeable fields */ | ||
| 85 | // void autosize(); | ||
| 86 | |||
| 87 | /* Hard applies the autosized values from SQL file */ | ||
| 88 | // void applySizingValues(); | ||
| 89 | |||
| 90 | //@} | ||
| 91 | protected: | ||
| 92 | /// @cond | ||
| 93 | using ImplType = detail::AirTerminalDualDuctConstantVolume_Impl; | ||
| 94 | |||
| 95 | explicit AirTerminalDualDuctConstantVolume(std::shared_ptr<detail::AirTerminalDualDuctConstantVolume_Impl> impl); | ||
| 96 | |||
| 97 | friend class detail::AirTerminalDualDuctConstantVolume_Impl; | ||
| 98 | friend class Model; | ||
| 99 | friend class IdfObject; | ||
| 100 | friend class openstudio::detail::IdfObject_Impl; | ||
| 101 | /// @endcond | ||
| 102 | private: | ||
| 103 | − | REGISTER_LOGGER("openstudio.model.AirTerminalDualDuctConstantVolume"); | |
| 104 | }; | ||
| 105 | |||
| 106 | /** \relates AirTerminalDualDuctConstantVolume*/ | ||
| 107 | using OptionalAirTerminalDualDuctConstantVolume = boost::optional<AirTerminalDualDuctConstantVolume>; | ||
| 108 | |||
| 109 | /** \relates AirTerminalDualDuctConstantVolume*/ | ||
| 110 | using AirTerminalDualDuctConstantVolumeVector = std::vector<AirTerminalDualDuctConstantVolume>; | ||
| 111 | |||
| 112 | } // namespace model | ||
| 113 | } // namespace openstudio | ||
| 114 | |||
| 115 | #endif // MODEL_AIRTERMINALDUALDUCTCONSTANTVOLUME_HPP | ||
| 116 |