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

#include <SolarCollectorPerformanceFlatPlate.hpp>

+ Inheritance diagram for openstudio::model::SolarCollectorPerformanceFlatPlate:

Public Member Functions

Constructors and Destructors
virtual ~SolarCollectorPerformanceFlatPlate ()
 
Getters
double grossArea () const
 
std::string testFluid () const
 
bool isTestFluidDefaulted () const
 
double testFlowRate () const
 
std::string testCorrelationType () const
 
double coefficient1ofEfficiencyEquation () const
 
double coefficient2ofEfficiencyEquation () const
 
boost::optional< double > coefficient3ofEfficiencyEquation () const
 
boost::optional< double > coefficient2ofIncidentAngleModifier () const
 
boost::optional< double > coefficient3ofIncidentAngleModifier () const
 
Setters
bool setGrossArea (double grossArea)
 
bool setTestFluid (std::string testFluid)
 
void resetTestFluid ()
 
bool setTestFlowRate (double testFlowRate)
 
bool setTestCorrelationType (std::string testCorrelationType)
 
bool setCoefficient1ofEfficiencyEquation (double coefficient1ofEfficiencyEquation)
 
bool setCoefficient2ofEfficiencyEquation (double coefficient2ofEfficiencyEquation)
 
bool setCoefficient3ofEfficiencyEquation (double coefficient3ofEfficiencyEquation)
 
void resetCoefficient3ofEfficiencyEquation ()
 
bool setCoefficient2ofIncidentAngleModifier (double coefficient2ofIncidentAngleModifier)
 
void resetCoefficient2ofIncidentAngleModifier ()
 
bool setCoefficient3ofIncidentAngleModifier (double coefficient3ofIncidentAngleModifier)
 
void resetCoefficient3ofIncidentAngleModifier ()
 
- 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...
 
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 ()
 
static std::vector< std::string > testCorrelationTypeValues ()
 
static std::vector< std::string > testFluidValues ()
 

Protected Member Functions

 SolarCollectorPerformanceFlatPlate (const Model &model)
 
- 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)
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< SolarCollectorPerformanceFlatPlate
OptionalSolarCollectorPerformanceFlatPlate
 
typedef std::vector
< SolarCollectorPerformanceFlatPlate
SolarCollectorPerformanceFlatPlateVector
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 

Detailed Description

SolarCollectorPerformanceFlatPlate is a ModelObject that wraps the OpenStudio IDD object 'OS:SolarCollectorPerformance:FlatPlate'.

Constructor & Destructor Documentation

virtual openstudio::model::SolarCollectorPerformanceFlatPlate::~SolarCollectorPerformanceFlatPlate ( )
inlinevirtual
openstudio::model::SolarCollectorPerformanceFlatPlate::SolarCollectorPerformanceFlatPlate ( const Model model)
explicitprotected

Member Function Documentation

double openstudio::model::SolarCollectorPerformanceFlatPlate::coefficient1ofEfficiencyEquation ( ) const
double openstudio::model::SolarCollectorPerformanceFlatPlate::coefficient2ofEfficiencyEquation ( ) const
boost::optional<double> openstudio::model::SolarCollectorPerformanceFlatPlate::coefficient2ofIncidentAngleModifier ( ) const
boost::optional<double> openstudio::model::SolarCollectorPerformanceFlatPlate::coefficient3ofEfficiencyEquation ( ) const
boost::optional<double> openstudio::model::SolarCollectorPerformanceFlatPlate::coefficient3ofIncidentAngleModifier ( ) const
double openstudio::model::SolarCollectorPerformanceFlatPlate::grossArea ( ) const
static IddObjectType openstudio::model::SolarCollectorPerformanceFlatPlate::iddObjectType ( )
static
bool openstudio::model::SolarCollectorPerformanceFlatPlate::isTestFluidDefaulted ( ) const
void openstudio::model::SolarCollectorPerformanceFlatPlate::resetCoefficient2ofIncidentAngleModifier ( )
void openstudio::model::SolarCollectorPerformanceFlatPlate::resetCoefficient3ofEfficiencyEquation ( )
void openstudio::model::SolarCollectorPerformanceFlatPlate::resetCoefficient3ofIncidentAngleModifier ( )
void openstudio::model::SolarCollectorPerformanceFlatPlate::resetTestFluid ( )
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setCoefficient1ofEfficiencyEquation ( double  coefficient1ofEfficiencyEquation)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setCoefficient2ofEfficiencyEquation ( double  coefficient2ofEfficiencyEquation)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setCoefficient2ofIncidentAngleModifier ( double  coefficient2ofIncidentAngleModifier)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setCoefficient3ofEfficiencyEquation ( double  coefficient3ofEfficiencyEquation)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setCoefficient3ofIncidentAngleModifier ( double  coefficient3ofIncidentAngleModifier)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setGrossArea ( double  grossArea)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setTestCorrelationType ( std::string  testCorrelationType)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setTestFlowRate ( double  testFlowRate)
bool openstudio::model::SolarCollectorPerformanceFlatPlate::setTestFluid ( std::string  testFluid)
std::string openstudio::model::SolarCollectorPerformanceFlatPlate::testCorrelationType ( ) const
static std::vector<std::string> openstudio::model::SolarCollectorPerformanceFlatPlate::testCorrelationTypeValues ( )
static
double openstudio::model::SolarCollectorPerformanceFlatPlate::testFlowRate ( ) const
std::string openstudio::model::SolarCollectorPerformanceFlatPlate::testFluid ( ) const
static std::vector<std::string> openstudio::model::SolarCollectorPerformanceFlatPlate::testFluidValues ( )
static

Friends And Related Function Documentation