src/model/GeneratorPVWatts_Impl.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_IMPL_HPP | ||
| 7 | #define MODEL_GENERATORPVWATTS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Generator_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class PlanarSurface; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** GeneratorPVWatts_Impl is a Generator_Impl that is the implementation class for GeneratorPVWatts.*/ | ||
| 20 | class MODEL_API GeneratorPVWatts_Impl : public Generator_Impl | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | GeneratorPVWatts_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | GeneratorPVWatts_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | GeneratorPVWatts_Impl(const GeneratorPVWatts_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 15 | virtual ~GeneratorPVWatts_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | /** @name Virtual Methods */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 40 | |||
| 41 | virtual IddObjectType iddObjectType() const override; | ||
| 42 | |||
| 43 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 44 | |||
| 45 | virtual std::string generatorObjectType() const override; | ||
| 46 | |||
| 47 | virtual boost::optional<Schedule> availabilitySchedule() const override; | ||
| 48 | |||
| 49 | virtual boost::optional<double> ratedElectricPowerOutput() const override; | ||
| 50 | |||
| 51 | virtual boost::optional<double> ratedThermaltoElectricalPowerRatio() const override; | ||
| 52 | |||
| 53 | //@} | ||
| 54 | /** @name Getters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | std::string pvWattsVersion() const; | ||
| 58 | |||
| 59 | double dcSystemCapacity() const; | ||
| 60 | |||
| 61 | std::string moduleType() const; | ||
| 62 | |||
| 63 | bool isModuleTypeDefaulted() const; | ||
| 64 | |||
| 65 | std::string arrayType() const; | ||
| 66 | |||
| 67 | bool isArrayTypeDefaulted() const; | ||
| 68 | |||
| 69 | double systemLosses() const; | ||
| 70 | |||
| 71 | bool isSystemLossesDefaulted() const; | ||
| 72 | |||
| 73 | double tiltAngle() const; | ||
| 74 | |||
| 75 | bool isTiltAngleDefaulted() const; | ||
| 76 | |||
| 77 | double azimuthAngle() const; | ||
| 78 | |||
| 79 | bool isAzimuthAngleDefaulted() const; | ||
| 80 | |||
| 81 | boost::optional<PlanarSurface> surface() const; | ||
| 82 | |||
| 83 | double groundCoverageRatio() const; | ||
| 84 | |||
| 85 | bool isGroundCoverageRatioDefaulted() const; | ||
| 86 | |||
| 87 | //@} | ||
| 88 | /** @name Setters */ | ||
| 89 | //@{ | ||
| 90 | |||
| 91 | bool setDCSystemCapacity(double dcSystemCapacity); | ||
| 92 | |||
| 93 | bool setModuleType(const std::string& moduleType); | ||
| 94 | |||
| 95 | void resetModuleType(); | ||
| 96 | |||
| 97 | bool setArrayType(const std::string& arrayType); | ||
| 98 | |||
| 99 | void resetArrayType(); | ||
| 100 | |||
| 101 | bool setSystemLosses(double systemLosses); | ||
| 102 | |||
| 103 | void resetSystemLosses(); | ||
| 104 | |||
| 105 | bool setTiltAngle(double tiltAngle); | ||
| 106 | |||
| 107 | void resetTiltAngle(); | ||
| 108 | |||
| 109 | bool setAzimuthAngle(double azimuthAngle); | ||
| 110 | |||
| 111 | void resetAzimuthAngle(); | ||
| 112 | |||
| 113 | bool setSurface(const PlanarSurface& surface); | ||
| 114 | |||
| 115 | void resetSurface(); | ||
| 116 | |||
| 117 | bool setGroundCoverageRatio(double groundCoverageRatio); | ||
| 118 | |||
| 119 | void resetGroundCoverageRatio(); | ||
| 120 | |||
| 121 | //@} | ||
| 122 | /** @name Other */ | ||
| 123 | //@{ | ||
| 124 | |||
| 125 | //@} | ||
| 126 | protected: | ||
| 127 | private: | ||
| 128 | REGISTER_LOGGER("openstudio.model.GeneratorPVWatts"); | ||
| 129 | }; | ||
| 130 | |||
| 131 | } // namespace detail | ||
| 132 | |||
| 133 | } // namespace model | ||
| 134 | } // namespace openstudio | ||
| 135 | |||
| 136 | #endif // MODEL_GENERATORPVWATTS_IMPL_HPP | ||
| 137 |