PlrBackDamper Class Referenceabstract

#include "PrjAirflowElements.hpp"

Inheritance diagram for openstudio::contam::PlrBackDamper:

Public Member Functions
	PlrBackDamper ()
	PlrBackDamper (int nr, int icon, std::string name, std::string desc)
	PlrBackDamper (int nr, int icon, std::string name, std::string desc, double lam, double Cp, double xp, double Cn, double xn)
	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)
	PlrBackDamper (const PlrBackDamper &other)
virtual	~PlrBackDamper () override=default
PlrBackDamper &	operator= (const PlrBackDamper &other)
bool	operator== (const PlrBackDamper &other) const
bool	operator!= (const PlrBackDamper &other) const
void	read (Reader &input)
void	readDetails (Reader &input)
std::string	write () override
int	nr () const override
void	setNr (const int nr) override
int	icon () const override
void	setIcon (const int icon) override
virtual std::string	dataType () const override=0
std::string	name () const override
void	setName (const std::string &name) override
std::string	desc () const override
void	setDesc (const std::string &desc) override
double	lam () const
bool	setLam (const double lam)
bool	setLam (const std::string &lam)
double	Cp () const
bool	setCp (const double Cp)
bool	setCp (const std::string &Cp)
double	xp () const
bool	setXp (const double xp)
bool	setXp (const std::string &xp)
double	Cn () const
bool	setCn (const double Cn)
bool	setCn (const std::string &Cn)
double	xn () const
bool	setXn (const double xn)
bool	setXn (const std::string &xn)

Detailed Description

The PlrBackDamper object is the base class of backdraft damper airflow elements.

Constructor & Destructor Documentation

openstudio::contam::PlrBackDamper::PlrBackDamper

(

)

Create a new object with default values.

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

Create a new object.

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.

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.

openstudio::contam::PlrBackDamper::PlrBackDamper

(

const PlrBackDamper &

other

)

Create a new object from another object.

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

overridevirtualdefault

Destroy the object.

Member Function Documentation

double openstudio::contam::PlrBackDamper::Cn

(

)

const

Returns the turbulent flow coefficient (dP < 0).

double openstudio::contam::PlrBackDamper::Cp

(

)

const

Returns the turbulent flow coefficient (dP > 0).

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.

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

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::PlrBackDamper::lam

(

)

const

Returns the laminar flow coefficient.

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

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

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.

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

(

const PlrBackDamper &

other

)

const

Inequality operator.

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

(

const PlrBackDamper &

other

)

Copy operator.

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

(

const PlrBackDamper &

other

)

const

Equality operator.

void openstudio::contam::PlrBackDamper::read

(

Reader &

input

)

Read an object from a Reader.

void openstudio::contam::PlrBackDamper::readDetails

(

Reader &

input

)

Read object details from a Reader.

bool openstudio::contam::PlrBackDamper::setCn

(

const double

Cn

)

Sets the turbulent flow coefficient (dP < 0).

bool openstudio::contam::PlrBackDamper::setCn

(

const std::string &

Cn

)

Sets the turbulent flow coefficient (dP < 0).

bool openstudio::contam::PlrBackDamper::setCp

(

const double

Cp

)

Sets the turbulent flow coefficient (dP > 0).

bool openstudio::contam::PlrBackDamper::setCp

(

const std::string &

Cp

)

Sets the turbulent flow coefficient (dP > 0).

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrBackDamper::setLam

(

const double

lam

)

Sets the laminar flow coefficient.

bool openstudio::contam::PlrBackDamper::setLam

(

const std::string &

lam

)

Sets the laminar flow coefficient.

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrBackDamper::setXn

(

const double

xn

)

Sets the pressure exponent (dP < 0).

bool openstudio::contam::PlrBackDamper::setXn

(

const std::string &

xn

)

Sets the pressure exponent (dP < 0).

bool openstudio::contam::PlrBackDamper::setXp

(

const double

xp

)

Sets the pressure exponent (dP > 0).

bool openstudio::contam::PlrBackDamper::setXp

(

const std::string &

xp

)

Sets the pressure exponent (dP > 0).

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

overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::PlrBackDamper::xn

(

)

const

Returns the pressure exponent (dP < 0).

double openstudio::contam::PlrBackDamper::xp

(

)

const

Returns the pressure exponent (dP > 0).