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

#include <GeneratorWindTurbine.hpp>

+ Inheritance diagram for openstudio::model::GeneratorWindTurbine:

Public Member Functions

Constructors and Destructors
 GeneratorWindTurbine (const Model &model)
 
virtual ~GeneratorWindTurbine ()
 
Getters
std::string rotorType () const
 
std::string powerControl () const
 
double ratedRotorSpeed () const
 
double rotorDiameter () const
 
double overallHeight () const
 
int numberofBlades () const
 
double ratedPower () const
 
double ratedWindSpeed () const
 
double cutInWindSpeed () const
 
double cutOutWindSpeed () const
 
double fractionSystemEfficiency () const
 
double maximumTipSpeedRatio () const
 
double maximumPowerCoefficient () const
 
boost::optional< double > annualLocalAverageWindSpeed () const
 
double heightforLocalAverageWindSpeed () const
 
double bladeChordArea () const
 
double bladeDragCoefficient () const
 
double bladeLiftCoefficient () const
 
double powerCoefficientC1 () const
 
double powerCoefficientC2 () const
 
double powerCoefficientC3 () const
 
double powerCoefficientC4 () const
 
double powerCoefficientC5 () const
 
double powerCoefficientC6 () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
bool setRotorType (std::string rotorType)
 
bool setPowerControl (std::string powerControl)
 
bool setRatedRotorSpeed (double ratedRotorSpeed)
 
bool setRotorDiameter (double rotorDiameter)
 
bool setOverallHeight (double overallHeight)
 
bool setNumberofBlades (int numberofBlades)
 
bool setRatedPower (double ratedPower)
 
bool setRatedWindSpeed (double ratedWindSpeed)
 
bool setCutInWindSpeed (double cutInWindSpeed)
 
bool setCutOutWindSpeed (double cutOutWindSpeed)
 
bool setFractionSystemEfficiency (double fractionSystemEfficiency)
 
bool setMaximumTipSpeedRatio (double maximumTipSpeedRatio)
 
bool setMaximumPowerCoefficient (double maximumPowerCoefficient)
 
bool setAnnualLocalAverageWindSpeed (double annualLocalAverageWindSpeed)
 
void resetAnnualLocalAverageWindSpeed ()
 
bool setHeightforLocalAverageWindSpeed (double heightforLocalAverageWindSpeed)
 
bool setBladeChordArea (double bladeChordArea)
 
bool setBladeDragCoefficient (double bladeDragCoefficient)
 
bool setBladeLiftCoefficient (double bladeLiftCoefficient)
 
bool setPowerCoefficientC1 (double powerCoefficientC1)
 
bool setPowerCoefficientC2 (double powerCoefficientC2)
 
bool setPowerCoefficientC3 (double powerCoefficientC3)
 
bool setPowerCoefficientC4 (double powerCoefficientC4)
 
bool setPowerCoefficientC5 (double powerCoefficientC5)
 
bool setPowerCoefficientC6 (double powerCoefficientC6)
 
- Public Member Functions inherited from openstudio::model::Generator
boost::optional< ScheduleavailabilitySchedule () const
 
boost::optional
< 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...
 
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< 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...
 
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< 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 IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< GeneratorWindTurbine
GeneratorWindTurbineVector
 
typedef boost::optional
< GeneratorWindTurbine
OptionalGeneratorWindTurbine
 

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

GeneratorWindTurbine is a Generator that wraps the OpenStudio IDD object 'OS:Generator:WindTurbine'.

Constructor & Destructor Documentation

openstudio::model::GeneratorWindTurbine::GeneratorWindTurbine ( const Model model)
explicit
virtual openstudio::model::GeneratorWindTurbine::~GeneratorWindTurbine ( )
inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::GeneratorWindTurbine::annualLocalAverageWindSpeed ( ) const
double openstudio::model::GeneratorWindTurbine::bladeChordArea ( ) const
double openstudio::model::GeneratorWindTurbine::bladeDragCoefficient ( ) const
double openstudio::model::GeneratorWindTurbine::bladeLiftCoefficient ( ) const
double openstudio::model::GeneratorWindTurbine::cutInWindSpeed ( ) const
double openstudio::model::GeneratorWindTurbine::cutOutWindSpeed ( ) const
double openstudio::model::GeneratorWindTurbine::fractionSystemEfficiency ( ) const
double openstudio::model::GeneratorWindTurbine::heightforLocalAverageWindSpeed ( ) const
static IddObjectType openstudio::model::GeneratorWindTurbine::iddObjectType ( )
static
double openstudio::model::GeneratorWindTurbine::maximumPowerCoefficient ( ) const
double openstudio::model::GeneratorWindTurbine::maximumTipSpeedRatio ( ) const
int openstudio::model::GeneratorWindTurbine::numberofBlades ( ) const
double openstudio::model::GeneratorWindTurbine::overallHeight ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC1 ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC2 ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC3 ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC4 ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC5 ( ) const
double openstudio::model::GeneratorWindTurbine::powerCoefficientC6 ( ) const
std::string openstudio::model::GeneratorWindTurbine::powerControl ( ) const
double openstudio::model::GeneratorWindTurbine::ratedPower ( ) const
double openstudio::model::GeneratorWindTurbine::ratedRotorSpeed ( ) const
double openstudio::model::GeneratorWindTurbine::ratedWindSpeed ( ) const
void openstudio::model::GeneratorWindTurbine::resetAnnualLocalAverageWindSpeed ( )
double openstudio::model::GeneratorWindTurbine::rotorDiameter ( ) const
std::string openstudio::model::GeneratorWindTurbine::rotorType ( ) const
bool openstudio::model::GeneratorWindTurbine::setAnnualLocalAverageWindSpeed ( double  annualLocalAverageWindSpeed)
bool openstudio::model::GeneratorWindTurbine::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::GeneratorWindTurbine::setBladeChordArea ( double  bladeChordArea)
bool openstudio::model::GeneratorWindTurbine::setBladeDragCoefficient ( double  bladeDragCoefficient)
bool openstudio::model::GeneratorWindTurbine::setBladeLiftCoefficient ( double  bladeLiftCoefficient)
bool openstudio::model::GeneratorWindTurbine::setCutInWindSpeed ( double  cutInWindSpeed)
bool openstudio::model::GeneratorWindTurbine::setCutOutWindSpeed ( double  cutOutWindSpeed)
bool openstudio::model::GeneratorWindTurbine::setFractionSystemEfficiency ( double  fractionSystemEfficiency)
bool openstudio::model::GeneratorWindTurbine::setHeightforLocalAverageWindSpeed ( double  heightforLocalAverageWindSpeed)
bool openstudio::model::GeneratorWindTurbine::setMaximumPowerCoefficient ( double  maximumPowerCoefficient)
bool openstudio::model::GeneratorWindTurbine::setMaximumTipSpeedRatio ( double  maximumTipSpeedRatio)
bool openstudio::model::GeneratorWindTurbine::setNumberofBlades ( int  numberofBlades)
bool openstudio::model::GeneratorWindTurbine::setOverallHeight ( double  overallHeight)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC1 ( double  powerCoefficientC1)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC2 ( double  powerCoefficientC2)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC3 ( double  powerCoefficientC3)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC4 ( double  powerCoefficientC4)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC5 ( double  powerCoefficientC5)
bool openstudio::model::GeneratorWindTurbine::setPowerCoefficientC6 ( double  powerCoefficientC6)
bool openstudio::model::GeneratorWindTurbine::setPowerControl ( std::string  powerControl)
bool openstudio::model::GeneratorWindTurbine::setRatedPower ( double  ratedPower)
bool openstudio::model::GeneratorWindTurbine::setRatedRotorSpeed ( double  ratedRotorSpeed)
bool openstudio::model::GeneratorWindTurbine::setRatedWindSpeed ( double  ratedWindSpeed)
bool openstudio::model::GeneratorWindTurbine::setRotorDiameter ( double  rotorDiameter)
bool openstudio::model::GeneratorWindTurbine::setRotorType ( std::string  rotorType)

Friends And Related Function Documentation

typedef std::vector<GeneratorWindTurbine> GeneratorWindTurbineVector
related
typedef boost::optional<GeneratorWindTurbine> OptionalGeneratorWindTurbine
related