 |
OpenStudio:model |
#include <GeneratorPhotovoltaic.hpp>
Inheritance diagram for openstudio::model::GeneratorPhotovoltaic:Public Member Functions | |
Getters | |
| boost::optional< PlanarSurface > | surface () const |
| PhotovoltaicPerformance | photovoltaicPerformance () const |
| std::string | heatTransferIntegrationMode () const |
| bool | isHeatTransferIntegrationModeDefaulted () const |
| double | numberOfModulesInParallel () const |
| bool | isNumberOfModulesInParallelDefaulted () const |
| double | numberOfModulesInSeries () const |
| bool | isNumberOfModulesInSeriesDefaulted () const |
| boost::optional< double > | ratedElectricPowerOutput () const |
| boost::optional< Schedule > | availabilitySchedule () const |
Setters | |
| bool | setSurface (const PlanarSurface &surface) |
| void | resetSurface () |
| bool | setHeatTransferIntegrationMode (const std::string &heatTransferIntegrationMode) |
| void | resetHeatTransferIntegrationMode () |
| bool | setNumberOfModulesInParallel (double numberOfModulesInParallel) |
| void | resetNumberOfModulesInParallel () |
| bool | setNumberOfModulesInSeries (double numberOfModulesInSeries) |
| void | resetNumberOfModulesInSeries () |
| bool | setRatedElectricPowerOutput (double ratedElectricPowerOutput) |
| void | resetRatedElectricPowerOutput () |
| bool | setAvailabilitySchedule (Schedule &schedule) |
| void | resetAvailabilitySchedule () |
| Public Member Functions inherited from openstudio::model::Generator | |
| boost::optional< Schedule > | availabilitySchedule () const |
| boost::optional < ElectricLoadCenterDistribution > | electricLoadCenterDistribution () const |
| Generator (IddObjectType type, const Model &model) | |
| Generator (const Generator &other)=default | |
| Generator (Generator &&other)=default | |
| std::string | generatorObjectType () const |
| Generator & | operator= (const Generator &)=default |
| Generator & | operator= (Generator &&)=default |
| boost::optional< double > | ratedElectricPowerOutput () const |
| boost::optional< double > | ratedThermaltoElectricalPowerRatio () const |
| virtual | ~Generator ()=default |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| ParentObject & | operator= (const ParentObject &)=default |
| ParentObject & | operator= (ParentObject &&)=default |
| ParentObject (const ParentObject &other)=default | |
| ParentObject (ParentObject &&other)=default | |
| virtual | ~ParentObject ()=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=default |
| ModelObject (const ModelObject &other)=default | |
| ModelObject (ModelObject &&other)=default | |
| ModelObject & | operator= (const ModelObject &)=default |
| ModelObject & | operator= (ModelObject &&)=default |
| ModelObject | clone () const |
| Creates a deep copy of this object, placing it in this object's model(). More... | |
| ModelObject | clone (Model model) const |
| Creates a deep copy of this object, placing it in model. More... | |
| Component | createComponent () const |
| Method for creating sharable Model snippets. More... | |
| Model | model () const |
| Returns the Model that contains this object. More... | |
| boost::optional< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () const |
| Get the resources directly used by this ModelObject. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources () const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObjectTarget (unsigned index) const |
| Get the object of type T pointed to by this object from field index. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectTargets () const |
| Get all objects of type T to which this object points. More... | |
| const std::vector< std::string > & | outputVariableNames () const |
| Get all output variables names that could be associated with this object. More... | |
| std::vector< OutputVariable > | outputVariables () const |
| Get all output variables associated with this object, must run simulation to generate data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| Get data associated with this output variable and this object. More... | |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| Returns the list of all LifeCycleCosts that refer to this object. More... | |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| Removes all LifeCycleCosts that refer to this object. More... | |
| IddObjectType | iddObjectType () const |
| This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
| AdditionalProperties | additionalProperties () const |
| Returns this object's additional properties, constructing a new object if necessary. More... | |
| bool | hasAdditionalProperties () const |
| Returns true if this object has additional properties. More... | |
| std::vector< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More... | |
| boost::optional< std::string > | cadObjectId () const |
| bool | setCADObjectId (const std::string &cadObjectId) |
| boost::optional< std::string > | gbXMLId () const |
| bool | setGBXMLId (const std::string &gbXMLId) |
| boost::optional< std::string > | displayName () const |
| bool | setDisplayName (const std::string &displayName) |
| bool | setParent (ParentObject &newParent) |
| set the parent, child may have to call non-const methods on the parent More... | |
| bool | operator< (const ModelObject &right) const |
| bool | operator== (const ModelObject &other) const |
| equality test More... | |
| bool | operator!= (const ModelObject &other) const |
| inequality test More... | |
| std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< double > | getAutosizedValue (const std::string &valueName, const std::string &units) const |
| Gets the autosized component value from the sql file. More... | |
| virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
| Return the names of the available ems actuators. More... | |
| virtual std::vector< std::string > | emsInternalVariableNames () const |
| Return the names of the available ems internal variables. More... | |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static std::vector< std::string > | heatTransferIntegrationModeValues () |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| using | GeneratorPhotovoltaicVector = std::vector< GeneratorPhotovoltaic > |
| using | OptionalGeneratorPhotovoltaic = boost::optional< GeneratorPhotovoltaic > |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| using | ImplType = detail::ModelObject_Impl |
| Protected Member Functions inherited from openstudio::model::ParentObject | |
| ParentObject (IddObjectType type, const Model &model) | |
| Constructs a new ParentObject object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::ModelObject | |
| ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
| ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
GeneratorPhotovoltaic is a Generator that wraps the OpenStudio IDD object 'OS:Generator:Photovoltaic'.
|
virtualdefault |
|
default |
|
default |
| boost::optional<Schedule> openstudio::model::GeneratorPhotovoltaic::availabilitySchedule | ( | ) | const |
|
static |
Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceEquivalentOneDiode performance.
|
static |
Factory method to creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceSandia by looking up characteristics in the embedded.
| std::string openstudio::model::GeneratorPhotovoltaic::heatTransferIntegrationMode | ( | ) | const |
|
static |
|
static |
| bool openstudio::model::GeneratorPhotovoltaic::isHeatTransferIntegrationModeDefaulted | ( | ) | const |
| bool openstudio::model::GeneratorPhotovoltaic::isNumberOfModulesInParallelDefaulted | ( | ) | const |
| bool openstudio::model::GeneratorPhotovoltaic::isNumberOfModulesInSeriesDefaulted | ( | ) | const |
| double openstudio::model::GeneratorPhotovoltaic::numberOfModulesInParallel | ( | ) | const |
| double openstudio::model::GeneratorPhotovoltaic::numberOfModulesInSeries | ( | ) | const |
|
default |
|
default |
| PhotovoltaicPerformance openstudio::model::GeneratorPhotovoltaic::photovoltaicPerformance | ( | ) | const |
| boost::optional<double> openstudio::model::GeneratorPhotovoltaic::ratedElectricPowerOutput | ( | ) | const |
| void openstudio::model::GeneratorPhotovoltaic::resetAvailabilitySchedule | ( | ) |
| void openstudio::model::GeneratorPhotovoltaic::resetHeatTransferIntegrationMode | ( | ) |
| void openstudio::model::GeneratorPhotovoltaic::resetNumberOfModulesInParallel | ( | ) |
| void openstudio::model::GeneratorPhotovoltaic::resetNumberOfModulesInSeries | ( | ) |
| void openstudio::model::GeneratorPhotovoltaic::resetRatedElectricPowerOutput | ( | ) |
| void openstudio::model::GeneratorPhotovoltaic::resetSurface | ( | ) |
|
static |
Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceSandia performance, using the default Ctor.
| bool openstudio::model::GeneratorPhotovoltaic::setAvailabilitySchedule | ( | Schedule & | schedule | ) |
| bool openstudio::model::GeneratorPhotovoltaic::setHeatTransferIntegrationMode | ( | const std::string & | heatTransferIntegrationMode | ) |
| bool openstudio::model::GeneratorPhotovoltaic::setNumberOfModulesInParallel | ( | double | numberOfModulesInParallel | ) |
| bool openstudio::model::GeneratorPhotovoltaic::setNumberOfModulesInSeries | ( | double | numberOfModulesInSeries | ) |
| bool openstudio::model::GeneratorPhotovoltaic::setRatedElectricPowerOutput | ( | double | ratedElectricPowerOutput | ) |
| bool openstudio::model::GeneratorPhotovoltaic::setSurface | ( | const PlanarSurface & | surface | ) |
|
static |
Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceSimple performance.
| boost::optional<PlanarSurface> openstudio::model::GeneratorPhotovoltaic::surface | ( | ) | const |
|
related |
|
related |