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

#include <AirflowNetworkEffectiveLeakageArea.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkEffectiveLeakageArea:

Public Member Functions

Constructors and Destructors
 AirflowNetworkEffectiveLeakageArea (const Model &model, double effectiveLeakageArea)
 Construct an effective leakage area object with default values and a specified effective leakage area. More...
 
 AirflowNetworkEffectiveLeakageArea (const Model &model, double effectiveLeakageArea, double dischargeCoefficient, double referencePressureDifference, double massFlowExponent)
 Construct an effective leakage area object. More...
 
virtual ~AirflowNetworkEffectiveLeakageArea ()
 
Getters
double effectiveLeakageArea () const
 Returns the effective leakage area in square meters. More...
 
double dischargeCoefficient () const
 Returns the discharge coefficient. More...
 
bool isDischargeCoefficientDefaulted () const
 Returns true if the discharge coefficient is defaulted. More...
 
double referencePressureDifference () const
 Returns the reference pressure difference in Pa. More...
 
bool isReferencePressureDifferenceDefaulted () const
 Returns true if the reference pressure difference is defaulted. More...
 
double airMassFlowExponent () const
 Returns the mass flow exponent. More...
 
bool isAirMassFlowExponentDefaulted () const
 Returns true if the mass flow exponent. More...
 
Setters
bool setEffectiveLeakageArea (double effectiveLeakageArea)
 Sets the effective leakage area in square meters. More...
 
bool setDischargeCoefficient (double dischargeCoefficient)
 Sets the discharge coefficient. More...
 
void resetDischargeCoefficient ()
 Returns the discharge coefficient to the default value. More...
 
bool setReferencePressureDifference (double referencePressureDifference)
 Sets the reference pressure difference in Pa. More...
 
void resetReferencePressureDifference ()
 Returns the reference pressure difference to the default value. More...
 
bool setAirMassFlowExponent (double airMassFlowExponent)
 Sets the mass flow exponent. More...
 
void resetAirMassFlowExponent ()
 Returns the mass flow exponent to the default value. More...
 
- 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
< AirflowNetworkEffectiveLeakageArea
AirflowNetworkEffectiveLeakageAreaVector
 
typedef boost::optional
< AirflowNetworkEffectiveLeakageArea
OptionalAirflowNetworkEffectiveLeakageArea
 

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

AirflowNetworkEffectiveLeakageArea is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetworkEffectiveLeakageArea'.

Constructor & Destructor Documentation

openstudio::model::AirflowNetworkEffectiveLeakageArea::AirflowNetworkEffectiveLeakageArea ( const Model model,
double  effectiveLeakageArea 
)

Construct an effective leakage area object with default values and a specified effective leakage area.

openstudio::model::AirflowNetworkEffectiveLeakageArea::AirflowNetworkEffectiveLeakageArea ( const Model model,
double  effectiveLeakageArea,
double  dischargeCoefficient,
double  referencePressureDifference,
double  massFlowExponent 
)

Construct an effective leakage area object.

virtual openstudio::model::AirflowNetworkEffectiveLeakageArea::~AirflowNetworkEffectiveLeakageArea ( )
inlinevirtual

Member Function Documentation

double openstudio::model::AirflowNetworkEffectiveLeakageArea::airMassFlowExponent ( ) const

Returns the mass flow exponent.

double openstudio::model::AirflowNetworkEffectiveLeakageArea::dischargeCoefficient ( ) const

Returns the discharge coefficient.

double openstudio::model::AirflowNetworkEffectiveLeakageArea::effectiveLeakageArea ( ) const

Returns the effective leakage area in square meters.

static IddObjectType openstudio::model::AirflowNetworkEffectiveLeakageArea::iddObjectType ( )
static
bool openstudio::model::AirflowNetworkEffectiveLeakageArea::isAirMassFlowExponentDefaulted ( ) const

Returns true if the mass flow exponent.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::isDischargeCoefficientDefaulted ( ) const

Returns true if the discharge coefficient is defaulted.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::isReferencePressureDifferenceDefaulted ( ) const

Returns true if the reference pressure difference is defaulted.

double openstudio::model::AirflowNetworkEffectiveLeakageArea::referencePressureDifference ( ) const

Returns the reference pressure difference in Pa.

void openstudio::model::AirflowNetworkEffectiveLeakageArea::resetAirMassFlowExponent ( )

Returns the mass flow exponent to the default value.

void openstudio::model::AirflowNetworkEffectiveLeakageArea::resetDischargeCoefficient ( )

Returns the discharge coefficient to the default value.

void openstudio::model::AirflowNetworkEffectiveLeakageArea::resetReferencePressureDifference ( )

Returns the reference pressure difference to the default value.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::setAirMassFlowExponent ( double  airMassFlowExponent)

Sets the mass flow exponent.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::setDischargeCoefficient ( double  dischargeCoefficient)

Sets the discharge coefficient.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::setEffectiveLeakageArea ( double  effectiveLeakageArea)

Sets the effective leakage area in square meters.

bool openstudio::model::AirflowNetworkEffectiveLeakageArea::setReferencePressureDifference ( double  referencePressureDifference)

Sets the reference pressure difference in Pa.

Friends And Related Function Documentation