src/model/SolarCollectorPerformanceFlatPlate.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_SOLARCOLLECTORPERFORMANCEFLATPLATE_HPP | ||
| 7 | #define MODEL_SOLARCOLLECTORPERFORMANCEFLATPLATE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class SolarCollectorPerformanceFlatPlate; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class SolarCollectorFlatPlateWater_Impl; | ||
| 21 | class SolarCollectorPerformanceFlatPlate_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** SolarCollectorPerformanceFlatPlate is a ModelObject that wraps the OpenStudio IDD object 'OS:SolarCollectorPerformance:FlatPlate'. */ | ||
| 26 | class MODEL_API SolarCollectorPerformanceFlatPlate : public ModelObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | 52 | virtual ~SolarCollectorPerformanceFlatPlate() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | 11 | SolarCollectorPerformanceFlatPlate(const SolarCollectorPerformanceFlatPlate& other) = default; | |
| 35 | 22 | SolarCollectorPerformanceFlatPlate(SolarCollectorPerformanceFlatPlate&& other) = default; | |
| 36 | ✗ | SolarCollectorPerformanceFlatPlate& operator=(const SolarCollectorPerformanceFlatPlate&) = default; | |
| 37 | ✗ | SolarCollectorPerformanceFlatPlate& operator=(SolarCollectorPerformanceFlatPlate&&) = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | static std::vector<std::string> testFluidValues(); | ||
| 44 | |||
| 45 | static std::vector<std::string> testCorrelationTypeValues(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | double grossArea() const; | ||
| 51 | |||
| 52 | std::string testFluid() const; | ||
| 53 | |||
| 54 | bool isTestFluidDefaulted() const; | ||
| 55 | |||
| 56 | double testFlowRate() const; | ||
| 57 | |||
| 58 | std::string testCorrelationType() const; | ||
| 59 | |||
| 60 | double coefficient1ofEfficiencyEquation() const; | ||
| 61 | |||
| 62 | double coefficient2ofEfficiencyEquation() const; | ||
| 63 | |||
| 64 | boost::optional<double> coefficient3ofEfficiencyEquation() const; | ||
| 65 | |||
| 66 | boost::optional<double> coefficient2ofIncidentAngleModifier() const; | ||
| 67 | |||
| 68 | boost::optional<double> coefficient3ofIncidentAngleModifier() const; | ||
| 69 | |||
| 70 | //@} | ||
| 71 | /** @name Setters */ | ||
| 72 | //@{ | ||
| 73 | |||
| 74 | bool setGrossArea(double grossArea); | ||
| 75 | |||
| 76 | bool setTestFluid(const std::string& testFluid); | ||
| 77 | |||
| 78 | void resetTestFluid(); | ||
| 79 | |||
| 80 | bool setTestFlowRate(double testFlowRate); | ||
| 81 | |||
| 82 | bool setTestCorrelationType(const std::string& testCorrelationType); | ||
| 83 | |||
| 84 | bool setCoefficient1ofEfficiencyEquation(double coefficient1ofEfficiencyEquation); | ||
| 85 | |||
| 86 | bool setCoefficient2ofEfficiencyEquation(double coefficient2ofEfficiencyEquation); | ||
| 87 | |||
| 88 | bool setCoefficient3ofEfficiencyEquation(double coefficient3ofEfficiencyEquation); | ||
| 89 | |||
| 90 | void resetCoefficient3ofEfficiencyEquation(); | ||
| 91 | |||
| 92 | bool setCoefficient2ofIncidentAngleModifier(double coefficient2ofIncidentAngleModifier); | ||
| 93 | |||
| 94 | void resetCoefficient2ofIncidentAngleModifier(); | ||
| 95 | |||
| 96 | bool setCoefficient3ofIncidentAngleModifier(double coefficient3ofIncidentAngleModifier); | ||
| 97 | |||
| 98 | void resetCoefficient3ofIncidentAngleModifier(); | ||
| 99 | |||
| 100 | //@} | ||
| 101 | /** @name Other */ | ||
| 102 | //@{ | ||
| 103 | |||
| 104 | //@} | ||
| 105 | protected: | ||
| 106 | explicit SolarCollectorPerformanceFlatPlate(const Model& model); | ||
| 107 | |||
| 108 | /// @cond | ||
| 109 | using ImplType = detail::SolarCollectorPerformanceFlatPlate_Impl; | ||
| 110 | |||
| 111 | explicit SolarCollectorPerformanceFlatPlate(std::shared_ptr<detail::SolarCollectorPerformanceFlatPlate_Impl> impl); | ||
| 112 | |||
| 113 | friend class detail::SolarCollectorPerformanceFlatPlate_Impl; | ||
| 114 | friend class detail::SolarCollectorFlatPlateWater_Impl; | ||
| 115 | friend class SolarCollectorFlatPlateWater; | ||
| 116 | friend class Model; | ||
| 117 | friend class IdfObject; | ||
| 118 | friend class openstudio::detail::IdfObject_Impl; | ||
| 119 | /// @endcond | ||
| 120 | private: | ||
| 121 | REGISTER_LOGGER("openstudio.model.SolarCollectorPerformanceFlatPlate"); | ||
| 122 | }; | ||
| 123 | |||
| 124 | /** \relates SolarCollectorPerformanceFlatPlate*/ | ||
| 125 | using OptionalSolarCollectorPerformanceFlatPlate = boost::optional<SolarCollectorPerformanceFlatPlate>; | ||
| 126 | |||
| 127 | /** \relates SolarCollectorPerformanceFlatPlate*/ | ||
| 128 | using SolarCollectorPerformanceFlatPlateVector = std::vector<SolarCollectorPerformanceFlatPlate>; | ||
| 129 | |||
| 130 | } // namespace model | ||
| 131 | } // namespace openstudio | ||
| 132 | |||
| 133 | #endif // MODEL_SOLARCOLLECTORPERFORMANCEFLATPLATE_HPP | ||
| 134 |