src/model/GeneratorPVWatts.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_GENERATORPVWATTS_HPP | ||
| 7 | #define MODEL_GENERATORPVWATTS_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Generator.hpp" | ||
| 11 | |||
| 12 | #include "PlanarSurface.hpp" | ||
| 13 | #include "PlanarSurface_Impl.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class PlanarSurface; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class GeneratorPVWatts_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** GeneratorPVWatts is a Generator that wraps the OpenStudio IDD object 'OS:Generator:PVWatts'. */ | ||
| 27 | class MODEL_API GeneratorPVWatts : public Generator | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit GeneratorPVWatts(const Model& model, double dcSystemCapacity); | ||
| 34 | |||
| 35 | explicit GeneratorPVWatts(const Model& model, const PlanarSurface& surface, double dcSystemCapacity); | ||
| 36 | |||
| 37 | 14 | virtual ~GeneratorPVWatts() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | ✗ | GeneratorPVWatts(const GeneratorPVWatts& other) = default; | |
| 40 | 1 | GeneratorPVWatts(GeneratorPVWatts&& other) = default; | |
| 41 | ✗ | GeneratorPVWatts& operator=(const GeneratorPVWatts&) = default; | |
| 42 | ✗ | GeneratorPVWatts& operator=(GeneratorPVWatts&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | std::string pvWattsVersion() const; | ||
| 52 | |||
| 53 | double dcSystemCapacity() const; | ||
| 54 | |||
| 55 | std::string moduleType() const; | ||
| 56 | |||
| 57 | bool isModuleTypeDefaulted() const; | ||
| 58 | |||
| 59 | std::string arrayType() const; | ||
| 60 | |||
| 61 | bool isArrayTypeDefaulted() const; | ||
| 62 | |||
| 63 | double systemLosses() const; | ||
| 64 | |||
| 65 | bool isSystemLossesDefaulted() const; | ||
| 66 | |||
| 67 | double tiltAngle() const; | ||
| 68 | |||
| 69 | bool isTiltAngleDefaulted() const; | ||
| 70 | |||
| 71 | double azimuthAngle() const; | ||
| 72 | |||
| 73 | bool isAzimuthAngleDefaulted() const; | ||
| 74 | |||
| 75 | boost::optional<PlanarSurface> surface() const; | ||
| 76 | |||
| 77 | double groundCoverageRatio() const; | ||
| 78 | |||
| 79 | bool isGroundCoverageRatioDefaulted() const; | ||
| 80 | |||
| 81 | //@} | ||
| 82 | /** @name Setters */ | ||
| 83 | //@{ | ||
| 84 | |||
| 85 | bool setDCSystemCapacity(double dcSystemCapacity); | ||
| 86 | |||
| 87 | bool setModuleType(const std::string& moduleType); | ||
| 88 | |||
| 89 | void resetModuleType(); | ||
| 90 | |||
| 91 | bool setArrayType(const std::string& arrayType); | ||
| 92 | |||
| 93 | void resetArrayType(); | ||
| 94 | |||
| 95 | bool setSystemLosses(double systemLosses); | ||
| 96 | |||
| 97 | void resetSystemLosses(); | ||
| 98 | |||
| 99 | bool setTiltAngle(double tiltAngle); | ||
| 100 | |||
| 101 | void resetTiltAngle(); | ||
| 102 | |||
| 103 | bool setAzimuthAngle(double azimuthAngle); | ||
| 104 | |||
| 105 | void resetAzimuthAngle(); | ||
| 106 | |||
| 107 | bool setSurface(const PlanarSurface& surface); | ||
| 108 | |||
| 109 | void resetSurface(); | ||
| 110 | |||
| 111 | bool setGroundCoverageRatio(double groundCoverageRatio); | ||
| 112 | |||
| 113 | void resetGroundCoverageRatio(); | ||
| 114 | |||
| 115 | //@} | ||
| 116 | /** @name Other */ | ||
| 117 | //@{ | ||
| 118 | |||
| 119 | //@} | ||
| 120 | protected: | ||
| 121 | /// @cond | ||
| 122 | |||
| 123 | using ImplType = detail::GeneratorPVWatts_Impl; | ||
| 124 | |||
| 125 | explicit GeneratorPVWatts(std::shared_ptr<detail::GeneratorPVWatts_Impl> impl); | ||
| 126 | |||
| 127 | friend class detail::GeneratorPVWatts_Impl; | ||
| 128 | friend class Model; | ||
| 129 | friend class IdfObject; | ||
| 130 | friend class openstudio::detail::IdfObject_Impl; | ||
| 131 | |||
| 132 | /// @endcond | ||
| 133 | private: | ||
| 134 | − | REGISTER_LOGGER("openstudio.model.GeneratorPVWatts"); | |
| 135 | }; | ||
| 136 | |||
| 137 | /** \relates GeneratorPVWatts*/ | ||
| 138 | using OptionalGeneratorPVWatts = boost::optional<GeneratorPVWatts>; | ||
| 139 | |||
| 140 | /** \relates GeneratorPVWatts*/ | ||
| 141 | using GeneratorPVWattsVector = std::vector<GeneratorPVWatts>; | ||
| 142 | |||
| 143 | } // namespace model | ||
| 144 | } // namespace openstudio | ||
| 145 | |||
| 146 | #endif // MODEL_GENERATORPVWATTS_HPP | ||
| 147 |