src/model/TemperingValve.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_TEMPERINGVALVE_HPP | ||
| 7 | #define MODEL_TEMPERINGVALVE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Node; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class TemperingValve_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** TemperingValve is a StraightComponent that wraps the OpenStudio IDD object 'OS:TemperingValve'. */ | ||
| 24 | class MODEL_API TemperingValve : public StraightComponent | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | explicit TemperingValve(const Model& model); | ||
| 31 | |||
| 32 | 3 | virtual ~TemperingValve() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | ✗ | TemperingValve(const TemperingValve& other) = default; | |
| 35 | ✗ | TemperingValve(TemperingValve&& other) = default; | |
| 36 | ✗ | TemperingValve& operator=(const TemperingValve&) = default; | |
| 37 | ✗ | TemperingValve& operator=(TemperingValve&&) = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | boost::optional<Node> stream2SourceNode() const; | ||
| 47 | |||
| 48 | boost::optional<Node> temperatureSetpointNode() const; | ||
| 49 | |||
| 50 | boost::optional<Node> pumpOutletNode() const; | ||
| 51 | |||
| 52 | //@} | ||
| 53 | /** @name Setters */ | ||
| 54 | //@{ | ||
| 55 | |||
| 56 | bool setStream2SourceNode(const Node& stream2SourceNode); | ||
| 57 | |||
| 58 | void resetStream2SourceNode(); | ||
| 59 | |||
| 60 | bool setTemperatureSetpointNode(const Node& temperatureSetpointNode); | ||
| 61 | |||
| 62 | void resetTemperatureSetpointNode(); | ||
| 63 | |||
| 64 | bool setPumpOutletNode(const Node& pumpOutletNode); | ||
| 65 | |||
| 66 | void resetPumpOutletNode(); | ||
| 67 | |||
| 68 | //@} | ||
| 69 | /** @name Other */ | ||
| 70 | //@{ | ||
| 71 | |||
| 72 | //@} | ||
| 73 | protected: | ||
| 74 | /// @cond | ||
| 75 | using ImplType = detail::TemperingValve_Impl; | ||
| 76 | |||
| 77 | explicit TemperingValve(std::shared_ptr<detail::TemperingValve_Impl> impl); | ||
| 78 | |||
| 79 | friend class detail::TemperingValve_Impl; | ||
| 80 | friend class Model; | ||
| 81 | friend class IdfObject; | ||
| 82 | friend class openstudio::detail::IdfObject_Impl; | ||
| 83 | /// @endcond | ||
| 84 | private: | ||
| 85 | REGISTER_LOGGER("openstudio.model.TemperingValve"); | ||
| 86 | }; | ||
| 87 | |||
| 88 | /** \relates TemperingValve*/ | ||
| 89 | using OptionalTemperingValve = boost::optional<TemperingValve>; | ||
| 90 | |||
| 91 | /** \relates TemperingValve*/ | ||
| 92 | using TemperingValveVector = std::vector<TemperingValve>; | ||
| 93 | |||
| 94 | } // namespace model | ||
| 95 | } // namespace openstudio | ||
| 96 | |||
| 97 | #endif // MODEL_TEMPERINGVALVE_HPP | ||
| 98 |