All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::GeneratorPhotovoltaic Class Reference

#include <GeneratorPhotovoltaic.hpp>

+ Inheritance diagram for openstudio::model::GeneratorPhotovoltaic:

Public Member Functions

boost::optional< PlanarSurfacesurface () 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< ScheduleavailabilitySchedule () const
bool setSurface (const PlanarSurface &surface)
void resetSurface ()
bool setHeatTransferIntegrationMode (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< ScheduleavailabilitySchedule () const
< ElectricLoadCenterDistribution
electricLoadCenterDistribution () const
 Generator (IddObjectType type, const Model &model)
std::string generatorObjectType () const
boost::optional< double > ratedElectricPowerOutput () const
boost::optional< double > ratedThermaltoElectricalPowerRatio () const
virtual ~Generator ()
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
virtual ~ParentObject ()
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
std::vector< LifeCycleCostlifeCycleCosts () 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...
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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) 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< ModelObjectconnectedObject (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.)

typedef std::vector
< GeneratorPhotovoltaic
typedef boost::optional
< GeneratorPhotovoltaic

Constructors and Destructors

static GeneratorPhotovoltaic simple (const Model &model)
 Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceSimple performance. More...
static GeneratorPhotovoltaic equivalentOneDiode (const Model &model)
 Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceEquivalentOneDiode performance. More...
virtual ~GeneratorPhotovoltaic ()

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- 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)

Detailed Description

GeneratorPhotovoltaic is a Generator that wraps the OpenStudio IDD object 'OS:Generator:Photovoltaic'.

Constructor & Destructor Documentation

virtual openstudio::model::GeneratorPhotovoltaic::~GeneratorPhotovoltaic ( )

Member Function Documentation

boost::optional<Schedule> openstudio::model::GeneratorPhotovoltaic::availabilitySchedule ( ) const
static GeneratorPhotovoltaic openstudio::model::GeneratorPhotovoltaic::equivalentOneDiode ( const Model model)
std::string openstudio::model::GeneratorPhotovoltaic::heatTransferIntegrationMode ( ) const
static std::vector<std::string> openstudio::model::GeneratorPhotovoltaic::heatTransferIntegrationModeValues ( )
static IddObjectType openstudio::model::GeneratorPhotovoltaic::iddObjectType ( )
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
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 ( )
bool openstudio::model::GeneratorPhotovoltaic::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::GeneratorPhotovoltaic::setHeatTransferIntegrationMode ( 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 GeneratorPhotovoltaic openstudio::model::GeneratorPhotovoltaic::simple ( const Model model)

Creates a GeneratorPhotovoltaic object with PhotovoltaicPerformanceSimple performance.

boost::optional<PlanarSurface> openstudio::model::GeneratorPhotovoltaic::surface ( ) const

Friends And Related Function Documentation

typedef std::vector<GeneratorPhotovoltaic> GeneratorPhotovoltaicVector
typedef boost::optional<GeneratorPhotovoltaic> OptionalGeneratorPhotovoltaic