src/model/SetpointManagerMixedAir.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_SETPOINTMANAGERMIXEDAIR_HPP | ||
| 7 | #define MODEL_SETPOINTMANAGERMIXEDAIR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SetpointManager.hpp" | ||
| 11 | #include <boost/optional.hpp> | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class SetpointManagerMixedAir_Impl; | ||
| 20 | |||
| 21 | } | ||
| 22 | |||
| 23 | /** SetpointManagerMixedAir is an interface to the IDD object | ||
| 24 | * named "OS:SetpointManager:MixedAir" | ||
| 25 | * | ||
| 26 | * The purpose of this class is to simplify the construction and manipulation | ||
| 27 | * of the EnergyPlus SetpointManager:MixedAir object. | ||
| 28 | */ | ||
| 29 | class MODEL_API SetpointManagerMixedAir : public SetpointManager | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | 862 | virtual ~SetpointManagerMixedAir() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | 8 | SetpointManagerMixedAir(const SetpointManagerMixedAir& other) = default; | |
| 35 | 13 | SetpointManagerMixedAir(SetpointManagerMixedAir&& other) = default; | |
| 36 | ✗ | SetpointManagerMixedAir& operator=(const SetpointManagerMixedAir&) = default; | |
| 37 | ✗ | SetpointManagerMixedAir& operator=(SetpointManagerMixedAir&&) = default; | |
| 38 | |||
| 39 | /** Constructs a new SetpointManagerMixedAir object and places it inside the | ||
| 40 | * model. The loop is fully initialized with all companion objects. | ||
| 41 | */ | ||
| 42 | explicit SetpointManagerMixedAir(const Model& model); | ||
| 43 | |||
| 44 | /** Returns the value of the ControlVariable field. **/ | ||
| 45 | std::string controlVariable() const; | ||
| 46 | |||
| 47 | /** Sets the value of the ControlVariable field. | ||
| 48 | * Options are Temperature. | ||
| 49 | */ | ||
| 50 | bool setControlVariable(const std::string& controlVariable); | ||
| 51 | |||
| 52 | /** Returns the Node referred to by the referenceSetpointNodeName. **/ | ||
| 53 | boost::optional<Node> referenceSetpointNode(); | ||
| 54 | |||
| 55 | /** Sets the Node referred to by the referenceSetpointNodeName. **/ | ||
| 56 | bool setReferenceSetpointNode(Node& node); | ||
| 57 | |||
| 58 | /** Returns the Node referred to by the fanInletNodeName. **/ | ||
| 59 | boost::optional<Node> fanInletNode(); | ||
| 60 | |||
| 61 | /** Sets the Node referred to by the fanInletNodeName. **/ | ||
| 62 | bool setFanInletNode(Node& node); | ||
| 63 | |||
| 64 | /** Returns the Node referred to by the fanOutletNodeName. **/ | ||
| 65 | boost::optional<Node> fanOutletNode(); | ||
| 66 | |||
| 67 | /** Sets the Node referred to by the fanOutletNodeName. **/ | ||
| 68 | bool setFanOutletNode(Node& node); | ||
| 69 | |||
| 70 | /** Returns the Node this setpoint manager is acting on. **/ | ||
| 71 | boost::optional<Node> setpointNode() const; | ||
| 72 | |||
| 73 | static IddObjectType iddObjectType(); | ||
| 74 | |||
| 75 | static void updateFanInletOutletNodes(AirLoopHVAC& airLoopHVAC); | ||
| 76 | |||
| 77 | protected: | ||
| 78 | friend class Model; | ||
| 79 | |||
| 80 | friend class openstudio::IdfObject; | ||
| 81 | |||
| 82 | friend class openstudio::detail::IdfObject_Impl; | ||
| 83 | |||
| 84 | friend class detail::SetpointManagerMixedAir_Impl; | ||
| 85 | |||
| 86 | /// @cond | ||
| 87 | |||
| 88 | using ImplType = detail::SetpointManagerMixedAir_Impl; | ||
| 89 | |||
| 90 | explicit SetpointManagerMixedAir(std::shared_ptr<detail::SetpointManagerMixedAir_Impl> impl); | ||
| 91 | |||
| 92 | private: | ||
| 93 | REGISTER_LOGGER("openstudio.model.SetpointManagerMixedAir"); | ||
| 94 | |||
| 95 | /// @endcond | ||
| 96 | }; | ||
| 97 | |||
| 98 | using OptionalSetpointManagerMixedAir = boost::optional<SetpointManagerMixedAir>; | ||
| 99 | |||
| 100 | using SetpointManagerMixedAirVector = std::vector<SetpointManagerMixedAir>; | ||
| 101 | |||
| 102 | } // namespace model | ||
| 103 | |||
| 104 | } // namespace openstudio | ||
| 105 | |||
| 106 | #endif // MODEL_SETPOINTMANAGERMIXEDAIR_HPP | ||
| 107 |