 |
OpenStudio:model |
#include <OutsideSurfaceConvectionAlgorithm.hpp>
Inheritance diagram for openstudio::model::OutsideSurfaceConvectionAlgorithm:Public Member Functions | |
| OutsideSurfaceConvectionAlgorithm & | operator= (const OutsideSurfaceConvectionAlgorithm &)=default |
| OutsideSurfaceConvectionAlgorithm & | operator= (OutsideSurfaceConvectionAlgorithm &&)=default |
| OutsideSurfaceConvectionAlgorithm (const OutsideSurfaceConvectionAlgorithm &other)=default | |
| OutsideSurfaceConvectionAlgorithm (OutsideSurfaceConvectionAlgorithm &&other)=default | |
| virtual | ~OutsideSurfaceConvectionAlgorithm ()=default |
Getters | |
| std::string | algorithm () const |
| bool | isAlgorithmDefaulted () const |
Setters | |
| bool | setAlgorithm (const std::string &algorithm) |
| void | resetAlgorithm () |
| 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 Methods | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | validAlgorithmValues () |
Protected Member Functions | |
Constructors and Destructors | |
| OutsideSurfaceConvectionAlgorithm (const Model &model) | |
| Constructs a new OutsideSurfaceConvectionAlgorithm 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) | |
Related Functions | |
(Note that these are not member functions.) | |
| using | OptionalOutsideSurfaceConvectionAlgorithm = boost::optional< OutsideSurfaceConvectionAlgorithm > |
| 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 |
OutsideSurfaceConvectionAlgorithm derives from ModelObject and is an interface to the OpenStudio IDD object named "SurfaceConvectionAlgorithm:Outside".
OutsideSurfaceConvectionAlgorithm is a unique object that specifies the global model used for surface convection at the outside face of all the heat transfer surfaces in the model. This global algorithm may be overridden for specific Surface, SurfaceList, or Zone objects. OutsideSurfaceConvectionAlgorithm does not have a public constructor because it is a unique ModelObject. To get the OutsideSurfaceConvectionAlgorithm object for a Model or create one if it does not yet exist use model.getUniqueObject<OutsideSurfaceConvectionAlgorithm>(). To get the OutsideSurfaceConvectionAlgorithm object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<OutsideSurfaceConvectionAlgorithm>().
|
virtualdefault |
|
default |
|
default |
|
explicitprotected |
Constructs a new OutsideSurfaceConvectionAlgorithm object in the model.
| std::string openstudio::model::OutsideSurfaceConvectionAlgorithm::algorithm | ( | ) | const |
|
static |
| bool openstudio::model::OutsideSurfaceConvectionAlgorithm::isAlgorithmDefaulted | ( | ) | const |
|
default |
|
default |
| void openstudio::model::OutsideSurfaceConvectionAlgorithm::resetAlgorithm | ( | ) |
| bool openstudio::model::OutsideSurfaceConvectionAlgorithm::setAlgorithm | ( | const std::string & | algorithm | ) |
|
static |
|
related |