openstudio::contam::AirflowElement Class Reference

#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::AirflowElement:

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

Static Public Member Functions
static AirflowElementType	convertTag (const std::string &tag)
	Convert an input string into an airflow element type enum.
static AirflowElement *	readElement (Reader &input)
	Read an airflow element from a Reader object.

Detailed Description

The AirflowElement object is the base class of all airflow elements.

Constructor & Destructor Documentation

~AirflowElement()

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

virtualdefault

Destroy the object.

Member Function Documentation

convertTag()

static AirflowElementType openstudio::contam::AirflowElement::convertTag ( const std::string & tag )

static

Convert an input string into an airflow element type enum.

dataType()

virtual std::string openstudio::contam::AirflowElement::dataType ( ) const

pure virtual

Returns the element data type.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak1, openstudio::contam::PlrLeak2, openstudio::contam::PlrLeak3, openstudio::contam::PlrConn, openstudio::contam::PlrQcn, openstudio::contam::PlrFcn, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBdq, openstudio::contam::PlrBdf, openstudio::contam::QfrQab, openstudio::contam::QfrFab, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeCmf, openstudio::contam::AfeCvf, openstudio::contam::AfeFan, openstudio::contam::AfeFsp, openstudio::contam::AfeQsp, openstudio::contam::AfePsf, openstudio::contam::AfePsq, openstudio::contam::AfeSup, openstudio::contam::PlrLeak, openstudio::contam::PlrGeneral, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, and openstudio::contam::AfeFlow.

desc()

virtual std::string openstudio::contam::AirflowElement::desc ( ) const

pure virtual

Returns the element description.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

icon()

virtual int openstudio::contam::AirflowElement::icon ( ) const

pure virtual

Returns the icon used to represent flow path.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

name()

virtual std::string openstudio::contam::AirflowElement::name ( ) const

pure virtual

Returns the element name.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

nr()

virtual int openstudio::contam::AirflowElement::nr ( ) const

pure virtual

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

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

readElement()

static AirflowElement * openstudio::contam::AirflowElement::readElement ( Reader & input )

static

Read an airflow element from a Reader object.

setDesc()

virtual void openstudio::contam::AirflowElement::setDesc ( const std::string & desc )

pure virtual

Sets the element description.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

setIcon()

virtual void openstudio::contam::AirflowElement::setIcon ( const int icon )

pure virtual

Sets the icon used to represent flow path.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

setName()

virtual void openstudio::contam::AirflowElement::setName ( const std::string & name )

pure virtual

Sets the element name.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

setNr()

virtual void openstudio::contam::AirflowElement::setNr ( const int nr )

pure virtual

Sets the element number.

This should only be done with care.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.

write()

virtual std::string openstudio::contam::AirflowElement::write ( )

pure virtual

Write the object to a string.

Implemented in openstudio::contam::PlrOrf, openstudio::contam::PlrLeak, openstudio::contam::PlrConn, openstudio::contam::PlrGeneral, openstudio::contam::PlrTest1, openstudio::contam::PlrTest2, openstudio::contam::PlrCrack, openstudio::contam::PlrStair, openstudio::contam::PlrShaft, openstudio::contam::PlrBackDamper, openstudio::contam::QfrGeneral, openstudio::contam::QfrCrack, openstudio::contam::QfrTest2, openstudio::contam::AfeDor, openstudio::contam::DrPl2, openstudio::contam::AfeFlow, openstudio::contam::AfeFan, openstudio::contam::AfeCsf, and openstudio::contam::AfeSup.