src/model/AirTerminalDualDuctVAVOutdoorAir.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_AIRTERMINALDUALDUCTVAVOUTDOORAIR_HPP | ||
| 7 | #define MODEL_AIRTERMINALDUALDUCTVAVOUTDOORAIR_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 | class DesignSpecificationOutdoorAir; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class AirTerminalDualDuctVAVOutdoorAir_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** AirTerminalDualDuctVAVOutdoorAir is a Mixer that wraps the OpenStudio IDD object 'OS:AirTerminal:DualDuct:VAV:OutdoorAir'. */ | ||
| 27 | class MODEL_API AirTerminalDualDuctVAVOutdoorAir : public Mixer | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit AirTerminalDualDuctVAVOutdoorAir(const Model& model); | ||
| 34 | |||
| 35 | 25 | virtual ~AirTerminalDualDuctVAVOutdoorAir() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | 2 | AirTerminalDualDuctVAVOutdoorAir(const AirTerminalDualDuctVAVOutdoorAir& other) = default; | |
| 38 | 3 | AirTerminalDualDuctVAVOutdoorAir(AirTerminalDualDuctVAVOutdoorAir&& other) = default; | |
| 39 | ✗ | AirTerminalDualDuctVAVOutdoorAir& operator=(const AirTerminalDualDuctVAVOutdoorAir&) = default; | |
| 40 | ✗ | AirTerminalDualDuctVAVOutdoorAir& operator=(AirTerminalDualDuctVAVOutdoorAir&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> perPersonVentilationRateModeValues(); | ||
| 47 | |||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | Schedule availabilitySchedule() const; | ||
| 52 | |||
| 53 | boost::optional<double> maximumTerminalAirFlowRate() const; | ||
| 54 | |||
| 55 | bool isMaximumTerminalAirFlowRateAutosized() const; | ||
| 56 | |||
| 57 | std::string perPersonVentilationRateMode() const; | ||
| 58 | |||
| 59 | //@} | ||
| 60 | /** @name Setters */ | ||
| 61 | //@{ | ||
| 62 | |||
| 63 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 64 | |||
| 65 | bool setMaximumTerminalAirFlowRate(double maximumTerminalAirFlowRate); | ||
| 66 | |||
| 67 | void autosizeMaximumTerminalAirFlowRate(); | ||
| 68 | |||
| 69 | /** If true, OpenStudio will attach the DesignSpecificationOutdoorAir object associated | ||
| 70 | * with the terminal's zone on export to EnergyPlus idf format. | ||
| 71 | * This field replaces the functionality of the EnergyPlus field: Design Specification Outdoor Air Object Name.*/ | ||
| 72 | bool controlForOutdoorAir() const; | ||
| 73 | bool setControlForOutdoorAir(bool controlForOutdoorAir); | ||
| 74 | |||
| 75 | bool setPerPersonVentilationRateMode(const std::string& perPersonVentilationRateMode); | ||
| 76 | |||
| 77 | /** This corresponds to Mixer::inletModelObject(0), as well as the system's branch 0 | ||
| 78 | * (ie. AirLoopHVAC::demandInletNodes()[0] and AirLoopHVAC::supplyOutletNodes()[0]) | ||
| 79 | * In OpenStudio we avoid using hot / cold nomenclature in the dual duct system api, | ||
| 80 | * but here in the terminal interface we use the language for transparency with the idf. | ||
| 81 | */ | ||
| 82 | boost::optional<Node> outdoorAirInletNode() const; | ||
| 83 | |||
| 84 | /** This corresponds to Mixer::inletModelObject(1), as well as the system's branch 1 | ||
| 85 | * (ie. AirLoopHVAC::demandInletNodes()[1] and AirLoopHVAC::supplyOutletNodes()[1]) | ||
| 86 | */ | ||
| 87 | boost::optional<Node> recirculatedAirInletNode() const; | ||
| 88 | |||
| 89 | //@} | ||
| 90 | /** @name Other */ | ||
| 91 | //@{ | ||
| 92 | |||
| 93 | /* Queries the autosized maximum terminal air flow rate from the SQL file */ | ||
| 94 | boost::optional<double> autosizedMaximumTerminalAirFlowRate() const; | ||
| 95 | |||
| 96 | /* Autosize all autosizeable fields */ | ||
| 97 | // void autosize(); | ||
| 98 | |||
| 99 | /* Hard applies the autosized values from SQL file */ | ||
| 100 | // void applySizingValues(); | ||
| 101 | |||
| 102 | //@} | ||
| 103 | protected: | ||
| 104 | /// @cond | ||
| 105 | using ImplType = detail::AirTerminalDualDuctVAVOutdoorAir_Impl; | ||
| 106 | |||
| 107 | explicit AirTerminalDualDuctVAVOutdoorAir(std::shared_ptr<detail::AirTerminalDualDuctVAVOutdoorAir_Impl> impl); | ||
| 108 | |||
| 109 | friend class detail::AirTerminalDualDuctVAVOutdoorAir_Impl; | ||
| 110 | friend class Model; | ||
| 111 | friend class IdfObject; | ||
| 112 | friend class openstudio::detail::IdfObject_Impl; | ||
| 113 | /// @endcond | ||
| 114 | private: | ||
| 115 | − | REGISTER_LOGGER("openstudio.model.AirTerminalDualDuctVAVOutdoorAir"); | |
| 116 | }; | ||
| 117 | |||
| 118 | /** \relates AirTerminalDualDuctVAVOutdoorAir*/ | ||
| 119 | using OptionalAirTerminalDualDuctVAVOutdoorAir = boost::optional<AirTerminalDualDuctVAVOutdoorAir>; | ||
| 120 | |||
| 121 | /** \relates AirTerminalDualDuctVAVOutdoorAir*/ | ||
| 122 | using AirTerminalDualDuctVAVOutdoorAirVector = std::vector<AirTerminalDualDuctVAVOutdoorAir>; | ||
| 123 | |||
| 124 | } // namespace model | ||
| 125 | } // namespace openstudio | ||
| 126 | |||
| 127 | #endif // MODEL_AIRTERMINALDUALDUCTVAVOUTDOORAIR_HPP | ||
| 128 |