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

#include <HeatBalanceAlgorithm.hpp>

+ Inheritance diagram for openstudio::model::HeatBalanceAlgorithm:

Public Member Functions

std::string algorithm () const
bool isAlgorithmDefaulted () const
double surfaceTemperatureUpperLimit () const
bool isSurfaceTemperatureUpperLimitDefaulted () const
double minimumSurfaceConvectionHeatTransferCoefficientValue () const
bool isMinimumSurfaceConvectionHeatTransferCoefficientValueDefaulted () const
double maximumSurfaceConvectionHeatTransferCoefficientValue () const
bool isMaximumSurfaceConvectionHeatTransferCoefficientValueDefaulted () const
bool setAlgorithm (std::string algorithm)
void resetAlgorithm ()
bool setSurfaceTemperatureUpperLimit (double surfaceTemperatureUpperLimit)
void resetSurfaceTemperatureUpperLimit ()
bool setMinimumSurfaceConvectionHeatTransferCoefficientValue (double minimumSurfaceConvectionHeatTransferCoefficientValue)
void resetMinimumSurfaceConvectionHeatTransferCoefficientValue ()
bool setMaximumSurfaceConvectionHeatTransferCoefficientValue (double maximumSurfaceConvectionHeatTransferCoefficientValue)
void resetMaximumSurfaceConvectionHeatTransferCoefficientValue ()
- 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 Methods
static IddObjectType iddObjectType ()
static std::vector< std::string > algorithmValues ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< HeatBalanceAlgorithm
typedef boost::optional
< HeatBalanceAlgorithm

Constructors and Destructors

virtual ~HeatBalanceAlgorithm ()
 HeatBalanceAlgorithm (const Model &model)
 Constructs a new HeatBalanceAlgorithm object in the model. More...

Additional Inherited Members

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

HeatBalanceAlgorithm derives from ModelObject and is an interface to the OpenStudio IDD object named "HeatBalanceAlgorithm".

HeatBalanceAlgorithm is a unique object that specifies the global heat and moisture algorithms used across building construction calculations. HeatBalanceAlgorithm does not have a public constructor because it is a unique ModelObject. To get the HeatBalanceAlgorithm object for a Model or create one if it does not yet exist use model.getUniqueObject<HeatBalanceAlgorithm>(). To get the HeatBalanceAlgorithm object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<HeatBalanceAlgorithm>().

Constructor & Destructor Documentation

virtual openstudio::model::HeatBalanceAlgorithm::~HeatBalanceAlgorithm ( )
openstudio::model::HeatBalanceAlgorithm::HeatBalanceAlgorithm ( const Model model)

Constructs a new HeatBalanceAlgorithm object in the model.

Member Function Documentation

std::string openstudio::model::HeatBalanceAlgorithm::algorithm ( ) const
static std::vector<std::string> openstudio::model::HeatBalanceAlgorithm::algorithmValues ( )
static IddObjectType openstudio::model::HeatBalanceAlgorithm::iddObjectType ( )
bool openstudio::model::HeatBalanceAlgorithm::isAlgorithmDefaulted ( ) const
bool openstudio::model::HeatBalanceAlgorithm::isMaximumSurfaceConvectionHeatTransferCoefficientValueDefaulted ( ) const
bool openstudio::model::HeatBalanceAlgorithm::isMinimumSurfaceConvectionHeatTransferCoefficientValueDefaulted ( ) const
bool openstudio::model::HeatBalanceAlgorithm::isSurfaceTemperatureUpperLimitDefaulted ( ) const
double openstudio::model::HeatBalanceAlgorithm::maximumSurfaceConvectionHeatTransferCoefficientValue ( ) const
double openstudio::model::HeatBalanceAlgorithm::minimumSurfaceConvectionHeatTransferCoefficientValue ( ) const
void openstudio::model::HeatBalanceAlgorithm::resetAlgorithm ( )
void openstudio::model::HeatBalanceAlgorithm::resetMaximumSurfaceConvectionHeatTransferCoefficientValue ( )
void openstudio::model::HeatBalanceAlgorithm::resetMinimumSurfaceConvectionHeatTransferCoefficientValue ( )
void openstudio::model::HeatBalanceAlgorithm::resetSurfaceTemperatureUpperLimit ( )
bool openstudio::model::HeatBalanceAlgorithm::setAlgorithm ( std::string  algorithm)
bool openstudio::model::HeatBalanceAlgorithm::setMaximumSurfaceConvectionHeatTransferCoefficientValue ( double  maximumSurfaceConvectionHeatTransferCoefficientValue)
bool openstudio::model::HeatBalanceAlgorithm::setMinimumSurfaceConvectionHeatTransferCoefficientValue ( double  minimumSurfaceConvectionHeatTransferCoefficientValue)
bool openstudio::model::HeatBalanceAlgorithm::setSurfaceTemperatureUpperLimit ( double  surfaceTemperatureUpperLimit)
double openstudio::model::HeatBalanceAlgorithm::surfaceTemperatureUpperLimit ( ) const

Friends And Related Function Documentation

typedef std::vector<HeatBalanceAlgorithm> HeatBalanceAlgorithmVector
typedef boost::optional<HeatBalanceAlgorithm> OptionalHeatBalanceAlgorithm