src/model/GeneratorPhotovoltaic_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_GENERATORPHOTOVOLTAIC_IMPL_HPP | ||
| 7 | #define MODEL_GENERATORPHOTOVOLTAIC_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Generator_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class AllShadingAndHTSurfName; | ||
| 16 | class PVModules; | ||
| 17 | class Schedule; | ||
| 18 | class PlanarSurface; | ||
| 19 | class PhotovoltaicPerformance; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** GeneratorPhotovoltaic_Impl is a Generator_Impl that is the implementation class for GeneratorPhotovoltaic.*/ | ||
| 24 | class MODEL_API GeneratorPhotovoltaic_Impl : public Generator_Impl | ||
| 25 | { | ||
| 26 | |||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | GeneratorPhotovoltaic_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | GeneratorPhotovoltaic_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | GeneratorPhotovoltaic_Impl(const GeneratorPhotovoltaic_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | 29 | virtual ~GeneratorPhotovoltaic_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | /** @name Virtual Methods */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 48 | |||
| 49 | /// returns PhotovoltaicPerformance | ||
| 50 | virtual std::vector<ModelObject> children() const override; | ||
| 51 | |||
| 52 | /// remove the object from the model's workspace | ||
| 53 | virtual std::vector<openstudio::IdfObject> remove() override; | ||
| 54 | |||
| 55 | /// get a vector of allowable children types | ||
| 56 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 57 | |||
| 58 | /// returns deletes reference to Surface from clone | ||
| 59 | virtual ModelObject clone(Model model) const override; | ||
| 60 | |||
| 61 | virtual std::string generatorObjectType() const override; | ||
| 62 | |||
| 63 | virtual boost::optional<double> ratedElectricPowerOutput() const override; | ||
| 64 | |||
| 65 | virtual boost::optional<Schedule> availabilitySchedule() const override; | ||
| 66 | |||
| 67 | virtual boost::optional<double> ratedThermaltoElectricalPowerRatio() const override; | ||
| 68 | |||
| 69 | //@} | ||
| 70 | /** @name Getters */ | ||
| 71 | //@{ | ||
| 72 | |||
| 73 | boost::optional<PlanarSurface> surface() const; | ||
| 74 | |||
| 75 | PhotovoltaicPerformance photovoltaicPerformance() const; | ||
| 76 | |||
| 77 | std::string heatTransferIntegrationMode() const; | ||
| 78 | |||
| 79 | bool isHeatTransferIntegrationModeDefaulted() const; | ||
| 80 | |||
| 81 | double numberOfModulesInParallel() const; | ||
| 82 | |||
| 83 | bool isNumberOfModulesInParallelDefaulted() const; | ||
| 84 | |||
| 85 | double numberOfModulesInSeries() const; | ||
| 86 | |||
| 87 | bool isNumberOfModulesInSeriesDefaulted() const; | ||
| 88 | |||
| 89 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 90 | |||
| 91 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 92 | |||
| 93 | //@} | ||
| 94 | /** @name Setters */ | ||
| 95 | //@{ | ||
| 96 | |||
| 97 | bool setSurface(const PlanarSurface& surface); | ||
| 98 | |||
| 99 | void resetSurface(); | ||
| 100 | |||
| 101 | bool setHeatTransferIntegrationMode(const std::string& heatTransferIntegrationMode); | ||
| 102 | |||
| 103 | void resetHeatTransferIntegrationMode(); | ||
| 104 | |||
| 105 | bool setNumberOfModulesInParallel(double numberOfModulesInParallel); | ||
| 106 | |||
| 107 | void resetNumberOfModulesInParallel(); | ||
| 108 | |||
| 109 | bool setNumberOfModulesInSeries(double numberOfModulesInSeries); | ||
| 110 | |||
| 111 | void resetNumberOfModulesInSeries(); | ||
| 112 | |||
| 113 | bool setRatedElectricPowerOutput(double ratedElectricPowerOutput); | ||
| 114 | |||
| 115 | void resetRatedElectricPowerOutput(); | ||
| 116 | |||
| 117 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 118 | |||
| 119 | void resetAvailabilitySchedule(); | ||
| 120 | |||
| 121 | //@} | ||
| 122 | /** @name Other */ | ||
| 123 | //@{ | ||
| 124 | |||
| 125 | //@} | ||
| 126 | protected: | ||
| 127 | private: | ||
| 128 | − | REGISTER_LOGGER("openstudio.model.GeneratorPhotovoltaic"); | |
| 129 | }; | ||
| 130 | |||
| 131 | } // namespace detail | ||
| 132 | |||
| 133 | } // namespace model | ||
| 134 | } // namespace openstudio | ||
| 135 | |||
| 136 | #endif // MODEL_GENERATORPHOTOVOLTAIC_IMPL_HPP | ||
| 137 |