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

#include <AirflowNetworkDuct.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkDuct:

Public Member Functions

Constructors and Destructors
 AirflowNetworkDuct (const Model &model)
 
virtual ~AirflowNetworkDuct ()
 
Getters
double ductLength () const
 
double hydraulicDiameter () const
 
double crossSectionArea () const
 
double surfaceRoughness () const
 
bool isSurfaceRoughnessDefaulted () const
 
double coefficientforLocalDynamicLossDuetoFitting () const
 
bool isCoefficientforLocalDynamicLossDuetoFittingDefaulted () const
 
double ductWallHeatTransmittanceCoefficient () const
 
bool isDuctWallHeatTransmittanceCoefficientDefaulted () const
 
double insideConvectionCoefficient () const
 
bool isInsideConvectionCoefficientDefaulted () const
 
double outsideConvectionCoefficient () const
 
bool isOutsideConvectionCoefficientDefaulted () const
 
double overallMoistureTransmittanceCoefficientfromAirtoAir () const
 
bool isOverallMoistureTransmittanceCoefficientfromAirtoAirDefaulted () const
 
Setters
bool setDuctLength (double ductLength)
 
bool setHydraulicDiameter (double hydraulicDiameter)
 
bool setCrossSectionArea (double crossSectionArea)
 
bool setSurfaceRoughness (double surfaceRoughness)
 
void resetSurfaceRoughness ()
 
bool setCoefficientforLocalDynamicLossDuetoFitting (double coefficientforLocalDynamicLossDuetoFitting)
 
void resetCoefficientforLocalDynamicLossDuetoFitting ()
 
bool setDuctWallHeatTransmittanceCoefficient (double coefficient)
 
void resetDuctWallHeatTransmittanceCoefficient ()
 
bool setInsideConvectionCoefficient (double coefficient)
 
void resetInsideConvectionCoefficient ()
 
bool setOutsideConvectionCoefficient (double coefficient)
 
void resetOutsideConvectionCoefficient ()
 
bool setOverallMoistureTransmittanceCoefficientfromAirtoAir (double overallMoistureTransmittanceCoefficientfromAirtoAir)
 
void resetOverallMoistureTransmittanceCoefficientfromAirtoAir ()
 
- Public Member Functions inherited from openstudio::model::AirflowNetworkComponent
 AirflowNetworkComponent (IddObjectType type, const Model &model)
 
boost::optional< ModelObjectcomponentModelObject () const
 
virtual ~AirflowNetworkComponent ()
 
- 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 ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< AirflowNetworkDuct
AirflowNetworkDuctVector
 
typedef boost::optional
< AirflowNetworkDuct
OptionalAirflowNetworkDuct
 

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

AirflowNetworkDuct is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetwork:Duct'.

Constructor & Destructor Documentation

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

Member Function Documentation

double openstudio::model::AirflowNetworkDuct::coefficientforLocalDynamicLossDuetoFitting ( ) const
double openstudio::model::AirflowNetworkDuct::crossSectionArea ( ) const
double openstudio::model::AirflowNetworkDuct::ductLength ( ) const
double openstudio::model::AirflowNetworkDuct::ductWallHeatTransmittanceCoefficient ( ) const
double openstudio::model::AirflowNetworkDuct::hydraulicDiameter ( ) const
static IddObjectType openstudio::model::AirflowNetworkDuct::iddObjectType ( )
static
double openstudio::model::AirflowNetworkDuct::insideConvectionCoefficient ( ) const
bool openstudio::model::AirflowNetworkDuct::isCoefficientforLocalDynamicLossDuetoFittingDefaulted ( ) const
bool openstudio::model::AirflowNetworkDuct::isDuctWallHeatTransmittanceCoefficientDefaulted ( ) const
bool openstudio::model::AirflowNetworkDuct::isInsideConvectionCoefficientDefaulted ( ) const
bool openstudio::model::AirflowNetworkDuct::isOutsideConvectionCoefficientDefaulted ( ) const
bool openstudio::model::AirflowNetworkDuct::isOverallMoistureTransmittanceCoefficientfromAirtoAirDefaulted ( ) const
bool openstudio::model::AirflowNetworkDuct::isSurfaceRoughnessDefaulted ( ) const
double openstudio::model::AirflowNetworkDuct::outsideConvectionCoefficient ( ) const
double openstudio::model::AirflowNetworkDuct::overallMoistureTransmittanceCoefficientfromAirtoAir ( ) const
void openstudio::model::AirflowNetworkDuct::resetCoefficientforLocalDynamicLossDuetoFitting ( )
void openstudio::model::AirflowNetworkDuct::resetDuctWallHeatTransmittanceCoefficient ( )
void openstudio::model::AirflowNetworkDuct::resetInsideConvectionCoefficient ( )
void openstudio::model::AirflowNetworkDuct::resetOutsideConvectionCoefficient ( )
void openstudio::model::AirflowNetworkDuct::resetOverallMoistureTransmittanceCoefficientfromAirtoAir ( )
void openstudio::model::AirflowNetworkDuct::resetSurfaceRoughness ( )
bool openstudio::model::AirflowNetworkDuct::setCoefficientforLocalDynamicLossDuetoFitting ( double  coefficientforLocalDynamicLossDuetoFitting)
bool openstudio::model::AirflowNetworkDuct::setCrossSectionArea ( double  crossSectionArea)
bool openstudio::model::AirflowNetworkDuct::setDuctLength ( double  ductLength)
bool openstudio::model::AirflowNetworkDuct::setDuctWallHeatTransmittanceCoefficient ( double  coefficient)
bool openstudio::model::AirflowNetworkDuct::setHydraulicDiameter ( double  hydraulicDiameter)
bool openstudio::model::AirflowNetworkDuct::setInsideConvectionCoefficient ( double  coefficient)
bool openstudio::model::AirflowNetworkDuct::setOutsideConvectionCoefficient ( double  coefficient)
bool openstudio::model::AirflowNetworkDuct::setOverallMoistureTransmittanceCoefficientfromAirtoAir ( double  overallMoistureTransmittanceCoefficientfromAirtoAir)
bool openstudio::model::AirflowNetworkDuct::setSurfaceRoughness ( double  surfaceRoughness)
double openstudio::model::AirflowNetworkDuct::surfaceRoughness ( ) const

Friends And Related Function Documentation

typedef std::vector<AirflowNetworkDuct> AirflowNetworkDuctVector
related
typedef boost::optional<AirflowNetworkDuct> OptionalAirflowNetworkDuct
related