openstudio::contam::PlrConn Class Reference

#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrConn:

Public Member Functions
Constructors and Destructors
	PlrConn ()
	Create a new object with default values.
	PlrConn (int nr, int icon, std::string name, std::string desc)
	Create a new object.
	PlrConn (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double area, double coef, int u_A)
	Create a new object.
	PlrConn (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string area, std::string coef, int u_A)
	Create a new object.
	PlrConn (const PlrConn &other)
	Create a new object from another object.
virtual	~PlrConn () override=default
	Destroy the object.
Operators
PlrConn &	operator= (const PlrConn &other)
	Copy operator.
bool	operator== (const PlrConn &other) const
	Equality operator.
bool	operator!= (const PlrConn &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.
std::string	dataType () const override
	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	turb () const
	Returns the turbulent flow coefficient.
bool	setTurb (const double turb)
	Sets the turbulent flow coefficient.
bool	setTurb (const std::string &turb)
	Sets the turbulent flow coefficient.
double	expt () const
	Returns the pressure exponent.
bool	setExpt (const double expt)
	Sets the pressure exponent.
bool	setExpt (const std::string &expt)
	Sets the pressure exponent.
double	area () const
	Returns the actual area [m^2].
bool	setArea (const double area1)
	Sets the actual area [m^2].
bool	setArea (const std::string &area1)
	Sets the actual area [m^2].
double	coef () const
	Returns the flow coefficient.
bool	setCoef (const double coef)
	Sets the flow coefficient.
bool	setCoef (const std::string &coef)
	Sets the flow coefficient.
int	u_A () const
	Returns the display units of area.
void	setU_A (const int u_A1)
	Sets the display units of area.
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 PlrConn object is an airflow element representing a ASCOS connection.

Constructor & Destructor Documentation

PlrConn() [1/5]

openstudio::contam::PlrConn::PlrConn

(

)

Create a new object with default values.

PlrConn() [2/5]

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

Create a new object.

PlrConn() [3/5]

openstudio::contam::PlrConn::PlrConn	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	turb,
		double	expt,
		double	area,
		double	coef,
		int	u_A )

Create a new object.

PlrConn() [4/5]

openstudio::contam::PlrConn::PlrConn	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	turb,
		std::string	expt,
		std::string	area,
		std::string	coef,
		int	u_A )

Create a new object.

PlrConn() [5/5]

openstudio::contam::PlrConn::PlrConn

(

const PlrConn &

other

)

Create a new object from another object.

~PlrConn()

virtual openstudio::contam::PlrConn::~PlrConn ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

area()

double openstudio::contam::PlrConn::area

(

)

const

Returns the actual area [m^2].

coef()

double openstudio::contam::PlrConn::coef

(

)

const

Returns the flow coefficient.

dataType()

std::string openstudio::contam::PlrConn::dataType ( ) const

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

desc()

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

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

expt()

double openstudio::contam::PlrConn::expt

(

)

const

Returns the pressure exponent.

icon()

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

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

lam()

double openstudio::contam::PlrConn::lam

(

)

const

Returns the laminar flow coefficient.

name()

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

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

nr()

int openstudio::contam::PlrConn::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::PlrConn::operator!=

(

const PlrConn &

other

)

const

Inequality operator.

operator=()

PlrConn & openstudio::contam::PlrConn::operator=

(

const PlrConn &

other

)

Copy operator.

operator==()

bool openstudio::contam::PlrConn::operator==

(

const PlrConn &

other

)

const

Equality operator.

read()

void openstudio::contam::PlrConn::read

(

Reader &

input

)

Read an object from a Reader.

readDetails()

void openstudio::contam::PlrConn::readDetails

(

Reader &

input

)

Read object details from a Reader.

setArea() [1/2]

bool openstudio::contam::PlrConn::setArea

(

const double

area1

)

Sets the actual area [m^2].

setArea() [2/2]

bool openstudio::contam::PlrConn::setArea

(

const std::string &

area1

)

Sets the actual area [m^2].

setCoef() [1/2]

bool openstudio::contam::PlrConn::setCoef

(

const double

coef

)

Sets the flow coefficient.

setCoef() [2/2]

bool openstudio::contam::PlrConn::setCoef

(

const std::string &

coef

)

Sets the flow coefficient.

setDesc()

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

setExpt() [1/2]

bool openstudio::contam::PlrConn::setExpt

(

const double

expt

)

Sets the pressure exponent.

setExpt() [2/2]

bool openstudio::contam::PlrConn::setExpt

(

const std::string &

expt

)

Sets the pressure exponent.

setIcon()

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

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

setLam() [1/2]

bool openstudio::contam::PlrConn::setLam

(

const double

lam

)

Sets the laminar flow coefficient.

setLam() [2/2]

bool openstudio::contam::PlrConn::setLam

(

const std::string &

lam

)

Sets the laminar flow coefficient.

setName()

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

setNr()

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

setTurb() [1/2]

bool openstudio::contam::PlrConn::setTurb

(

const double

turb

)

Sets the turbulent flow coefficient.

setTurb() [2/2]

bool openstudio::contam::PlrConn::setTurb

(

const std::string &

turb

)

Sets the turbulent flow coefficient.

setU_A()

void openstudio::contam::PlrConn::setU_A

(

const int

u_A1

)

Sets the display units of area.

turb()

double openstudio::contam::PlrConn::turb

(

)

const

Returns the turbulent flow coefficient.

u_A()

int openstudio::contam::PlrConn::u_A

(

)

const

Returns the display units of area.

write()

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

overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.