OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
Public Types | Public Member Functions | Static Public Member Functions | List of all members
openstudio::contam::AirflowElement Class Referenceabstract

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::AirflowElement:

Public Types

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...
 

Public Member Functions

virtual std::string dataType () const =0
 Returns the element data type. More...
 
virtual std::string desc () const =0
 Returns the element description. More...
 
virtual int icon () const =0
 Returns the icon used to represent flow path. More...
 
virtual std::string name () const =0
 Returns the element name. More...
 
virtual int nr () const =0
 Returns the element number, in order from 1 to the number of airflow elements. More...
 
virtual void setDesc (const std::string &desc)=0
 Sets the element description. More...
 
virtual void setIcon (const int icon)=0
 Sets the icon used to represent flow path. More...
 
virtual void setName (const std::string &name)=0
 Sets the element name. More...
 
virtual void setNr (const int nr)=0
 Sets the element number. More...
 
virtual std::string write ()=0
 Write the object to a string. More...
 
virtual ~AirflowElement ()
 Destroy the object. More...
 

Static Public Member Functions

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 AirflowElement object is the base class of all airflow elements.

Member Enumeration Documentation

The Type enumeration is used to identify the various airflow element types.

Enumerator
PL_ORFC 
PL_LEAK1 
PL_LEAK2 
PL_LEAK3 
PL_CONN 
PL_QCN 
PL_FCN 
PL_TEST1 
PL_TEST2 
PL_CRACK 
PL_STAIR 
PL_SHAFT 
PL_BDQ 
PL_BDF 
QFR_QAB 
QFR_QAF 
QFR_CRACK 
QFR_TEST2 
DR_DOOR 
DR_PL2 
FN_CMF 
FN_CVF 
FN_FAN 
CS_FSP 
CS_QSP 
CS_PSF 
CS_PSQ 
AF_SUP 
UNKNOWN 

Constructor & Destructor Documentation

virtual openstudio::contam::AirflowElement::~AirflowElement ( )
inlinevirtual

Destroy the object.

Member Function Documentation

static Type openstudio::contam::AirflowElement::convertTag ( std::string  string)
static

Convert an input string into an airflow element type enum.

virtual std::string openstudio::contam::AirflowElement::dataType ( ) const
pure virtual
virtual std::string openstudio::contam::AirflowElement::desc ( ) const
pure virtual
virtual int openstudio::contam::AirflowElement::icon ( ) const
pure virtual
virtual std::string openstudio::contam::AirflowElement::name ( ) const
pure virtual
virtual int openstudio::contam::AirflowElement::nr ( ) const
pure virtual
static AirflowElement* openstudio::contam::AirflowElement::readElement ( Reader input)
static

Read an airflow element from a Reader object.

virtual void openstudio::contam::AirflowElement::setDesc ( const std::string &  desc)
pure virtual
virtual void openstudio::contam::AirflowElement::setIcon ( const int  icon)
pure virtual
virtual void openstudio::contam::AirflowElement::setName ( const std::string &  name)
pure virtual
virtual void openstudio::contam::AirflowElement::setNr ( const int  nr)
pure virtual
virtual std::string openstudio::contam::AirflowElement::write ( )
pure virtual