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