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

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::AfeFlow:

Public Member Functions

Constructors and Destructors
 AfeFlow ()
 Create a new object with default values. More...
 
 AfeFlow (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 AfeFlow (int nr, int icon, std::string name, std::string desc, double Flow, int u_F)
 Create a new object. More...
 
 AfeFlow (int nr, int icon, std::string name, std::string desc, std::string Flow, int u_F)
 Create a new object. More...
 
 AfeFlow (const AfeFlow &other)
 Create a new object from another object. More...
 
 ~AfeFlow ()
 Destroy the object. More...
 
Operators
AfeFlowoperator= (const AfeFlow &other)
 Copy operator. More...
 
bool operator== (const AfeFlow &other) const
 Equality operator. More...
 
bool operator!= (const AfeFlow &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=0
 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 Flow () const
 Returns the design flow rate [kg/s or m^3/s]. More...
 
bool setFlow (const double Flow)
 Sets the design flow rate [kg/s or m^3/s]. More...
 
bool setFlow (const std::string &Flow)
 Sets the design flow rate [kg/s or m^3/s]. More...
 
int u_F () const
 Returns the display units of design flow rate. More...
 
void setU_F (const int u_F)
 Sets the display units of design flow rate. 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 AfeFlow object is the base class of constant flow rate airflow elements.

Constructor & Destructor Documentation

openstudio::contam::AfeFlow::AfeFlow ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::AfeFlow::AfeFlow ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  Flow,
int  u_F 
)

Create a new object.

openstudio::contam::AfeFlow::AfeFlow ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  Flow,
int  u_F 
)

Create a new object.

openstudio::contam::AfeFlow::AfeFlow ( const AfeFlow other)

Create a new object from another object.

openstudio::contam::AfeFlow::~AfeFlow ( )

Destroy the object.

Member Function Documentation

std::string openstudio::contam::AfeFlow::dataType ( ) const
overridepure virtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

Implemented in openstudio::contam::AfeCvf, and openstudio::contam::AfeCmf.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::AfeFlow::Flow ( ) const

Returns the design flow rate [kg/s or m^3/s].

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::AfeFlow::setFlow ( const double  Flow)

Sets the design flow rate [kg/s or m^3/s].

bool openstudio::contam::AfeFlow::setFlow ( const std::string &  Flow)

Sets the design flow rate [kg/s or m^3/s].

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeFlow::setU_F ( const int  u_F)

Sets the display units of design flow rate.

int openstudio::contam::AfeFlow::u_F ( ) const

Returns the display units of design flow rate.

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.