src/model/SolarCollectorFlatPlateWater.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_SOLARCOLLECTORFLATPLATEWATER_HPP | ||
| 7 | #define MODEL_SOLARCOLLECTORFLATPLATEWATER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class SolarCollectorPerformanceFlatPlate; | ||
| 17 | class PlanarSurface; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class SolarCollectorFlatPlateWater_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** SolarCollectorFlatPlateWater is a StraightComponent that wraps the OpenStudio IDD object 'OS:SolarCollector:FlatPlate:Water'. */ | ||
| 26 | class MODEL_API SolarCollectorFlatPlateWater : public StraightComponent | ||
| 27 | { | ||
| 28 | |||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit SolarCollectorFlatPlateWater(const Model& model); | ||
| 34 | |||
| 35 | 14 | virtual ~SolarCollectorFlatPlateWater() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | SolarCollectorFlatPlateWater(const SolarCollectorFlatPlateWater& other) = default; | |
| 38 | 2 | SolarCollectorFlatPlateWater(SolarCollectorFlatPlateWater&& other) = default; | |
| 39 | ✗ | SolarCollectorFlatPlateWater& operator=(const SolarCollectorFlatPlateWater&) = default; | |
| 40 | ✗ | SolarCollectorFlatPlateWater& operator=(SolarCollectorFlatPlateWater&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | SolarCollectorPerformanceFlatPlate solarCollectorPerformance() const; | ||
| 50 | |||
| 51 | boost::optional<PlanarSurface> surface() const; | ||
| 52 | |||
| 53 | boost::optional<double> maximumFlowRate() const; | ||
| 54 | |||
| 55 | //@} | ||
| 56 | /** @name Setters */ | ||
| 57 | //@{ | ||
| 58 | |||
| 59 | /// Deletes the current parameters and clones the parameters passed in | ||
| 60 | bool setSolarCollectorPerformance(const SolarCollectorPerformanceFlatPlate& parameters); | ||
| 61 | |||
| 62 | /// Deletes the current parameters and constructs a new default set of parameters | ||
| 63 | void resetSolarCollectorPerformance(); | ||
| 64 | |||
| 65 | bool setSurface(const PlanarSurface& surface); | ||
| 66 | |||
| 67 | void resetSurface(); | ||
| 68 | |||
| 69 | //bool setInletNode(const Connection& connection); | ||
| 70 | |||
| 71 | //bool setOutletNode(const Connection& connection); | ||
| 72 | |||
| 73 | bool setMaximumFlowRate(double maximumFlowRate); | ||
| 74 | |||
| 75 | void resetMaximumFlowRate(); | ||
| 76 | |||
| 77 | //@} | ||
| 78 | /** @name Other */ | ||
| 79 | //@{ | ||
| 80 | |||
| 81 | //@} | ||
| 82 | protected: | ||
| 83 | /// @cond | ||
| 84 | using ImplType = detail::SolarCollectorFlatPlateWater_Impl; | ||
| 85 | |||
| 86 | explicit SolarCollectorFlatPlateWater(std::shared_ptr<detail::SolarCollectorFlatPlateWater_Impl> impl); | ||
| 87 | |||
| 88 | friend class detail::SolarCollectorFlatPlateWater_Impl; | ||
| 89 | friend class Model; | ||
| 90 | friend class IdfObject; | ||
| 91 | friend class openstudio::detail::IdfObject_Impl; | ||
| 92 | /// @endcond | ||
| 93 | private: | ||
| 94 | REGISTER_LOGGER("openstudio.model.SolarCollectorFlatPlateWater"); | ||
| 95 | }; | ||
| 96 | |||
| 97 | /** \relates SolarCollectorFlatPlateWater*/ | ||
| 98 | using OptionalSolarCollectorFlatPlateWater = boost::optional<SolarCollectorFlatPlateWater>; | ||
| 99 | |||
| 100 | /** \relates SolarCollectorFlatPlateWater*/ | ||
| 101 | using SolarCollectorFlatPlateWaterVector = std::vector<SolarCollectorFlatPlateWater>; | ||
| 102 | |||
| 103 | } // namespace model | ||
| 104 | } // namespace openstudio | ||
| 105 | |||
| 106 | #endif // MODEL_SOLARCOLLECTORFLATPLATEWATER_HPP | ||
| 107 |