openstudio::contam::PlrBackDamper Class Reference

#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrBackDamper:

Public Member Functions
Constructors and Destructors
	PlrBackDamper ()
	Create a new object with default values.
	PlrBackDamper (int nr, int icon, std::string name, std::string desc)
	Create a new object.
	PlrBackDamper (int nr, int icon, std::string name, std::string desc, double lam, double Cp, double xp, double Cn, double xn)
	Create a new object.
	PlrBackDamper (int nr, int icon, std::string name, std::string desc, std::string lam, std::string Cp, std::string xp, std::string Cn, std::string xn)
	Create a new object.
	PlrBackDamper (const PlrBackDamper &other)
	Create a new object from another object.
virtual	~PlrBackDamper () override=default
	Destroy the object.
Operators
PlrBackDamper &	operator= (const PlrBackDamper &other)
	Copy operator.
bool	operator== (const PlrBackDamper &other) const
	Equality operator.
bool	operator!= (const PlrBackDamper &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
void	readDetails (Reader &input)
	Read object details from a Reader.
std::string	write () override
	Write the object to a string.
Getters and Setters
int	nr () const override
	Returns the element number, in order from 1 to the number of airflow elements.
void	setNr (const int nr) override
	Sets the element number.
int	icon () const override
	Returns the icon used to represent flow path.
void	setIcon (const int icon) override
	Sets the icon used to represent flow path.
virtual std::string	dataType () const override=0
	Returns the element data type.
std::string	name () const override
	Returns the element name.
void	setName (const std::string &name) override
	Sets the element name.
std::string	desc () const override
	Returns the element description.
void	setDesc (const std::string &desc) override
	Sets the element description.
double	lam () const
	Returns the laminar flow coefficient.
bool	setLam (const double lam)
	Sets the laminar flow coefficient.
bool	setLam (const std::string &lam)
	Sets the laminar flow coefficient.
double	Cp () const
	Returns the turbulent flow coefficient (dP > 0).
bool	setCp (const double Cp)
	Sets the turbulent flow coefficient (dP > 0).
bool	setCp (const std::string &Cp)
	Sets the turbulent flow coefficient (dP > 0).
double	xp () const
	Returns the pressure exponent (dP > 0).
bool	setXp (const double xp)
	Sets the pressure exponent (dP > 0).
bool	setXp (const std::string &xp)
	Sets the pressure exponent (dP > 0).
double	Cn () const
	Returns the turbulent flow coefficient (dP < 0).
bool	setCn (const double Cn)
	Sets the turbulent flow coefficient (dP < 0).
bool	setCn (const std::string &Cn)
	Sets the turbulent flow coefficient (dP < 0).
double	xn () const
	Returns the pressure exponent (dP < 0).
bool	setXn (const double xn)
	Sets the pressure exponent (dP < 0).
bool	setXn (const std::string &xn)
	Sets the pressure exponent (dP < 0).
Public Member Functions inherited from openstudio::contam::AirflowElement
virtual	~AirflowElement ()=default
	Destroy the object.

Additional Inherited Members
Static Public Member Functions inherited from openstudio::contam::AirflowElement
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 PlrBackDamper object is the base class of backdraft damper airflow elements.

Constructor & Destructor Documentation

PlrBackDamper() [1/5]

openstudio::contam::PlrBackDamper::PlrBackDamper

(

)

Create a new object with default values.

PlrBackDamper() [2/5]

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

Create a new object.

PlrBackDamper() [3/5]

openstudio::contam::PlrBackDamper::PlrBackDamper	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	Cp,
		double	xp,
		double	Cn,
		double	xn )

Create a new object.

PlrBackDamper() [4/5]

openstudio::contam::PlrBackDamper::PlrBackDamper	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	Cp,
		std::string	xp,
		std::string	Cn,
		std::string	xn )

Create a new object.

PlrBackDamper() [5/5]

openstudio::contam::PlrBackDamper::PlrBackDamper

(

const PlrBackDamper &

other

)

Create a new object from another object.

~PlrBackDamper()

virtual openstudio::contam::PlrBackDamper::~PlrBackDamper ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

Cn()

double openstudio::contam::PlrBackDamper::Cn

(

)

const

Returns the turbulent flow coefficient (dP < 0).

Cp()

double openstudio::contam::PlrBackDamper::Cp

(

)

const

Returns the turbulent flow coefficient (dP > 0).

dataType()

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

overridepure virtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

Implemented in openstudio::contam::PlrBdf, and openstudio::contam::PlrBdq.

desc()

std::string openstudio::contam::PlrBackDamper::desc ( ) const

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

icon()

int openstudio::contam::PlrBackDamper::icon ( ) const

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

lam()

double openstudio::contam::PlrBackDamper::lam

(

)

const

Returns the laminar flow coefficient.

name()

std::string openstudio::contam::PlrBackDamper::name ( ) const

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

nr()

int openstudio::contam::PlrBackDamper::nr ( ) const

overridevirtual

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

Implements openstudio::contam::AirflowElement.

operator!=()

bool openstudio::contam::PlrBackDamper::operator!=

(

const PlrBackDamper &

other

)

const

Inequality operator.

operator=()

PlrBackDamper & openstudio::contam::PlrBackDamper::operator=

(

const PlrBackDamper &

other

)

Copy operator.

operator==()

bool openstudio::contam::PlrBackDamper::operator==

(

const PlrBackDamper &

other

)

const

Equality operator.

read()

void openstudio::contam::PlrBackDamper::read

(

Reader &

input

)

Read an object from a Reader.

readDetails()

void openstudio::contam::PlrBackDamper::readDetails

(

Reader &

input

)

Read object details from a Reader.

setCn() [1/2]

bool openstudio::contam::PlrBackDamper::setCn

(

const double

Cn

)

Sets the turbulent flow coefficient (dP < 0).

setCn() [2/2]

bool openstudio::contam::PlrBackDamper::setCn

(

const std::string &

Cn

)

Sets the turbulent flow coefficient (dP < 0).

setCp() [1/2]

bool openstudio::contam::PlrBackDamper::setCp

(

const double

Cp

)

Sets the turbulent flow coefficient (dP > 0).

setCp() [2/2]

bool openstudio::contam::PlrBackDamper::setCp

(

const std::string &

Cp

)

Sets the turbulent flow coefficient (dP > 0).

setDesc()

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

setIcon()

void openstudio::contam::PlrBackDamper::setIcon ( const int icon )

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

setLam() [1/2]

bool openstudio::contam::PlrBackDamper::setLam

(

const double

lam

)

Sets the laminar flow coefficient.

setLam() [2/2]

bool openstudio::contam::PlrBackDamper::setLam

(

const std::string &

lam

)

Sets the laminar flow coefficient.

setName()

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

setNr()

void openstudio::contam::PlrBackDamper::setNr ( const int nr )

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

setXn() [1/2]

bool openstudio::contam::PlrBackDamper::setXn

(

const double

xn

)

Sets the pressure exponent (dP < 0).

setXn() [2/2]

bool openstudio::contam::PlrBackDamper::setXn

(

const std::string &

xn

)

Sets the pressure exponent (dP < 0).

setXp() [1/2]

bool openstudio::contam::PlrBackDamper::setXp

(

const double

xp

)

Sets the pressure exponent (dP > 0).

setXp() [2/2]

bool openstudio::contam::PlrBackDamper::setXp

(

const std::string &

xp

)

Sets the pressure exponent (dP > 0).

write()

std::string openstudio::contam::PlrBackDamper::write ( )

overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.

xn()

double openstudio::contam::PlrBackDamper::xn

(

)

const

Returns the pressure exponent (dP < 0).

xp()

double openstudio::contam::PlrBackDamper::xp

(

)

const

Returns the pressure exponent (dP > 0).