src/model/PipeIndoor.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_PIPEINDOOR_HPP | ||
| 7 | #define MODEL_PIPEINDOOR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Construction; | ||
| 17 | class Schedule; | ||
| 18 | class ThermalZone; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class PipeIndoor_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** PipeIndoor is a StraightComponent that wraps the OpenStudio IDD object 'OS:Pipe:Indoor'. */ | ||
| 27 | class MODEL_API PipeIndoor : public StraightComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit PipeIndoor(const Model& model); | ||
| 34 | |||
| 35 | 5 | virtual ~PipeIndoor() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | PipeIndoor(const PipeIndoor& other) = default; | |
| 38 | ✗ | PipeIndoor(PipeIndoor&& other) = default; | |
| 39 | ✗ | PipeIndoor& operator=(const PipeIndoor&) = default; | |
| 40 | ✗ | PipeIndoor& operator=(PipeIndoor&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> environmentTypeValues(); | ||
| 47 | |||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | boost::optional<Construction> construction() const; | ||
| 52 | |||
| 53 | std::string environmentType() const; | ||
| 54 | |||
| 55 | boost::optional<ThermalZone> ambientTemperatureZone() const; | ||
| 56 | |||
| 57 | boost::optional<Schedule> ambientTemperatureSchedule() const; | ||
| 58 | |||
| 59 | boost::optional<Schedule> ambientAirVelocitySchedule() const; | ||
| 60 | |||
| 61 | double pipeInsideDiameter() const; | ||
| 62 | |||
| 63 | double pipeLength() const; | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Setters */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | bool setConstruction(const Construction& construction); | ||
| 70 | |||
| 71 | void resetConstruction(); | ||
| 72 | |||
| 73 | bool setEnvironmentType(const std::string& environmentType); | ||
| 74 | |||
| 75 | bool setAmbientTemperatureZone(const ThermalZone& thermalZone); | ||
| 76 | |||
| 77 | void resetAmbientTemperatureZone(); | ||
| 78 | |||
| 79 | bool setAmbientTemperatureSchedule(Schedule& schedule); | ||
| 80 | |||
| 81 | void resetAmbientTemperatureSchedule(); | ||
| 82 | |||
| 83 | bool setAmbientAirVelocitySchedule(Schedule& schedule); | ||
| 84 | |||
| 85 | void resetAmbientAirVelocitySchedule(); | ||
| 86 | |||
| 87 | bool setPipeInsideDiameter(double pipeInsideDiameter); | ||
| 88 | |||
| 89 | bool setPipeLength(double pipeLength); | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Other */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | //@} | ||
| 96 | protected: | ||
| 97 | /// @cond | ||
| 98 | using ImplType = detail::PipeIndoor_Impl; | ||
| 99 | |||
| 100 | explicit PipeIndoor(std::shared_ptr<detail::PipeIndoor_Impl> impl); | ||
| 101 | |||
| 102 | friend class detail::PipeIndoor_Impl; | ||
| 103 | friend class Model; | ||
| 104 | friend class IdfObject; | ||
| 105 | friend class openstudio::detail::IdfObject_Impl; | ||
| 106 | /// @endcond | ||
| 107 | private: | ||
| 108 | REGISTER_LOGGER("openstudio.model.PipeIndoor"); | ||
| 109 | }; | ||
| 110 | |||
| 111 | /** \relates PipeIndoor*/ | ||
| 112 | using OptionalPipeIndoor = boost::optional<PipeIndoor>; | ||
| 113 | |||
| 114 | /** \relates PipeIndoor*/ | ||
| 115 | using PipeIndoorVector = std::vector<PipeIndoor>; | ||
| 116 | |||
| 117 | } // namespace model | ||
| 118 | } // namespace openstudio | ||
| 119 | |||
| 120 | #endif // MODEL_PIPEINDOOR_HPP | ||
| 121 |