OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
List of all members
openstudio::contam::QfrCrack Class Reference

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::QfrCrack:

Public Member Functions

Constructors and Destructors
 QfrCrack ()
 Create a new object with default values. More...
 
 QfrCrack (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 QfrCrack (int nr, int icon, std::string name, std::string desc, double a, double b, double length, double width, double depth, int nB, int u_L, int u_W, int u_D)
 Create a new object. More...
 
 QfrCrack (int nr, int icon, std::string name, std::string desc, std::string a, std::string b, std::string length, std::string width, std::string depth, int nB, int u_L, int u_W, int u_D)
 Create a new object. More...
 
 QfrCrack (const QfrCrack &other)
 Create a new object from another object. More...
 
 ~QfrCrack ()
 Destroy the object. More...
 
Operators
QfrCrackoperator= (const QfrCrack &other)
 Copy operator. More...
 
bool operator== (const QfrCrack &other) const
 Equality operator. More...
 
bool operator!= (const QfrCrack &other) const
 Inequality operator. More...
 
Input and Output
void read (Reader &input)
 Read an object from a Reader. More...
 
void readDetails (Reader &input)
 Read object details from a Reader. More...
 
std::string write () override
 Write the object to a string. More...
 
Getters and Setters
int nr () const override
 Returns the element number, in order from 1 to the number of airflow elements. More...
 
void setNr (const int nr) override
 Sets the element number. More...
 
int icon () const override
 Returns the icon used to represent flow path. More...
 
void setIcon (const int icon) override
 Sets the icon used to represent flow path. More...
 
std::string dataType () const override
 Returns the element data type. More...
 
std::string name () const override
 Returns the element name. More...
 
void setName (const std::string &name) override
 Sets the element name. More...
 
std::string desc () const override
 Returns the element description. More...
 
void setDesc (const std::string &desc) override
 Sets the element description. More...
 
double a () const
 Returns the flow rate coefficient. More...
 
bool setA (const double a)
 Sets the flow rate coefficient. More...
 
bool setA (const std::string &a)
 Sets the flow rate coefficient. More...
 
double b () const
 Returns the flow rate^2 coefficient. More...
 
bool setB (const double b)
 Sets the flow rate^2 coefficient. More...
 
bool setB (const std::string &b)
 Sets the flow rate^2 coefficient. More...
 
double length () const
 Returns the crack length [m]. More...
 
bool setLength (const double length)
 Sets the crack length [m]. More...
 
bool setLength (const std::string &length)
 Sets the crack length [m]. More...
 
double width () const
 Returns the crack width [m]. More...
 
bool setWidth (const double width)
 Sets the crack width [m]. More...
 
bool setWidth (const std::string &width)
 Sets the crack width [m]. More...
 
double depth () const
 Sets the crack depth [m]. More...
 
bool setDepth (const double depth)
 Sets the crack depth [m]. More...
 
bool setDepth (const std::string &depth)
 Sets the crack depth [m]. More...
 
int nB () const
 Returns the number of bends. More...
 
void setNB (const int nB)
 Sets the number of bends. More...
 
int u_L () const
 Returns the display units of length. More...
 
void setU_L (const int u_L)
 Sets the display units of length. More...
 
int u_W () const
 Returns the display units of width. More...
 
void setU_W (const int u_W)
 Sets the display units of width. More...
 
int u_D () const
 Returns the display units of depth. More...
 
void setU_D (const int u_D)
 Sets the display units of width. More...
 
- Public Member Functions inherited from openstudio::contam::AirflowElement
virtual ~AirflowElement ()
 Destroy the object. More...
 

Additional Inherited Members

- Public Types inherited from openstudio::contam::AirflowElement
enum  Type {
  PL_ORFC =0, PL_LEAK1 =1, PL_LEAK2 =2, PL_LEAK3 =3,
  PL_CONN =4, PL_QCN =5, PL_FCN =6, PL_TEST1 =7,
  PL_TEST2 =8, PL_CRACK =9, PL_STAIR =10, PL_SHAFT =11,
  PL_BDQ =12, PL_BDF =13, QFR_QAB =14, QFR_QAF =15,
  QFR_CRACK =16, QFR_TEST2 =17, DR_DOOR =18, DR_PL2 =19,
  FN_CMF =20, FN_CVF =21, FN_FAN =22, CS_FSP =23,
  CS_QSP =24, CS_PSF =25, CS_PSQ =26, AF_SUP =27,
  UNKNOWN
}
 The Type enumeration is used to identify the various airflow element types. More...
 
- Static Public Member Functions inherited from openstudio::contam::AirflowElement
static Type convertTag (std::string string)
 Convert an input string into an airflow element type enum. More...
 
static AirflowElementreadElement (Reader &input)
 Read an airflow element from a Reader object. More...
 

Detailed Description

The QfrCrack object is an airflow element representing quadratic leakage through a crack.

Constructor & Destructor Documentation

openstudio::contam::QfrCrack::QfrCrack ( )

Create a new object with default values.

openstudio::contam::QfrCrack::QfrCrack ( int  nr,
int  icon,
std::string  name,
std::string  desc 
)

Create a new object.

openstudio::contam::QfrCrack::QfrCrack ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  a,
double  b,
double  length,
double  width,
double  depth,
int  nB,
int  u_L,
int  u_W,
int  u_D 
)

Create a new object.

openstudio::contam::QfrCrack::QfrCrack ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  a,
std::string  b,
std::string  length,
std::string  width,
std::string  depth,
int  nB,
int  u_L,
int  u_W,
int  u_D 
)

Create a new object.

openstudio::contam::QfrCrack::QfrCrack ( const QfrCrack other)

Create a new object from another object.

openstudio::contam::QfrCrack::~QfrCrack ( )

Destroy the object.

Member Function Documentation

double openstudio::contam::QfrCrack::a ( ) const

Returns the flow rate coefficient.

double openstudio::contam::QfrCrack::b ( ) const

Returns the flow rate^2 coefficient.

std::string openstudio::contam::QfrCrack::dataType ( ) const
inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::QfrCrack::depth ( ) const

Sets the crack depth [m].

std::string openstudio::contam::QfrCrack::desc ( ) const
overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::QfrCrack::icon ( ) const
overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::QfrCrack::length ( ) const

Returns the crack length [m].

std::string openstudio::contam::QfrCrack::name ( ) const
overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::QfrCrack::nB ( ) const

Returns the number of bends.

int openstudio::contam::QfrCrack::nr ( ) const
overridevirtual

Returns the element number, in order from 1 to the number of airflow elements.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::QfrCrack::operator!= ( const QfrCrack other) const

Inequality operator.

QfrCrack& openstudio::contam::QfrCrack::operator= ( const QfrCrack other)

Copy operator.

bool openstudio::contam::QfrCrack::operator== ( const QfrCrack other) const

Equality operator.

void openstudio::contam::QfrCrack::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::QfrCrack::readDetails ( Reader input)

Read object details from a Reader.

bool openstudio::contam::QfrCrack::setA ( const double  a)

Sets the flow rate coefficient.

bool openstudio::contam::QfrCrack::setA ( const std::string &  a)

Sets the flow rate coefficient.

bool openstudio::contam::QfrCrack::setB ( const double  b)

Sets the flow rate^2 coefficient.

bool openstudio::contam::QfrCrack::setB ( const std::string &  b)

Sets the flow rate^2 coefficient.

bool openstudio::contam::QfrCrack::setDepth ( const double  depth)

Sets the crack depth [m].

bool openstudio::contam::QfrCrack::setDepth ( const std::string &  depth)

Sets the crack depth [m].

void openstudio::contam::QfrCrack::setDesc ( const std::string &  desc)
overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::QfrCrack::setIcon ( const int  icon)
overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::QfrCrack::setLength ( const double  length)

Sets the crack length [m].

bool openstudio::contam::QfrCrack::setLength ( const std::string &  length)

Sets the crack length [m].

void openstudio::contam::QfrCrack::setName ( const std::string &  name)
overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::QfrCrack::setNB ( const int  nB)

Sets the number of bends.

void openstudio::contam::QfrCrack::setNr ( const int  nr)
overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::QfrCrack::setU_D ( const int  u_D)

Sets the display units of width.

void openstudio::contam::QfrCrack::setU_L ( const int  u_L)

Sets the display units of length.

void openstudio::contam::QfrCrack::setU_W ( const int  u_W)

Sets the display units of width.

bool openstudio::contam::QfrCrack::setWidth ( const double  width)

Sets the crack width [m].

bool openstudio::contam::QfrCrack::setWidth ( const std::string &  width)

Sets the crack width [m].

int openstudio::contam::QfrCrack::u_D ( ) const

Returns the display units of depth.

int openstudio::contam::QfrCrack::u_L ( ) const

Returns the display units of length.

int openstudio::contam::QfrCrack::u_W ( ) const

Returns the display units of width.

double openstudio::contam::QfrCrack::width ( ) const

Returns the crack width [m].

std::string openstudio::contam::QfrCrack::write ( )
overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.