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