OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
List of all members
openstudio::contam::AfeCsf Class Reference

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::AfeCsf:

Public Member Functions

Constructors and Destructors
 AfeCsf ()
 Create a new object with default values. More...
 
 AfeCsf (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 AfeCsf (int nr, int icon, std::string name, std::string desc, int u_x, int u_y, std::vector< XyDataPoint > data)
 Create a new object. More...
 
 AfeCsf (const AfeCsf &other)
 Create a new object from another object. More...
 
 ~AfeCsf ()
 Destroy the object. More...
 
Operators
AfeCsfoperator= (const AfeCsf &other)
 Copy operator. More...
 
bool operator== (const AfeCsf &other) const
 Equality operator. More...
 
bool operator!= (const AfeCsf &other) const
 Inequality operator. More...
 
Input and Output
void read (Reader &input)
 Read an object from a Reader. More...
 
void readDetails (Reader &input)
 Read object details from a Reader. More...
 
std::string write () override
 Write the object to a string. More...
 
Getters and Setters
int nr () const override
 Returns the element number, in order from 1 to the number of airflow elements. More...
 
void setNr (const int nr) override
 Sets the element number. More...
 
int icon () const override
 Returns the icon used to represent flow path. More...
 
void setIcon (const int icon) override
 Sets the icon used to represent flow path. More...
 
std::string name () const override
 Returns the element name. More...
 
void setName (const std::string &name) override
 Sets the element name. More...
 
std::string desc () const override
 Returns the element description. More...
 
void setDesc (const std::string &desc) override
 Sets the element description. More...
 
int u_x () const
 Returns the display units for x. More...
 
void setU_x (const int u_x)
 Sets the display units for x. More...
 
int u_y () const
 Returns the display units for y. More...
 
void setU_y (const int u_y)
 Sets the display units for y. More...
 
std::vector< XyDataPointdata () const
 Returns the data point vector of (x,y) pairs. More...
 
void setData (const std::vector< XyDataPoint > &data)
 Sets the data point vector. More...
 
- Public Member Functions inherited from openstudio::contam::AirflowElement
virtual std::string dataType () const =0
 Returns the element data type. More...
 
virtual ~AirflowElement ()
 Destroy the object. More...
 

Additional Inherited Members

- Public Types inherited from openstudio::contam::AirflowElement
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...
 
- Static Public Member Functions inherited from openstudio::contam::AirflowElement
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 AfeCvf object is the base class of airflow element representing cubic spline leakage.

Constructor & Destructor Documentation

openstudio::contam::AfeCsf::AfeCsf ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::AfeCsf::AfeCsf ( int  nr,
int  icon,
std::string  name,
std::string  desc,
int  u_x,
int  u_y,
std::vector< XyDataPoint data 
)

Create a new object.

openstudio::contam::AfeCsf::AfeCsf ( const AfeCsf other)

Create a new object from another object.

openstudio::contam::AfeCsf::~AfeCsf ( )

Destroy the object.

Member Function Documentation

std::vector<XyDataPoint> openstudio::contam::AfeCsf::data ( ) const

Returns the data point vector of (x,y) pairs.

std::string openstudio::contam::AfeCsf::desc ( ) const
overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::AfeCsf::icon ( ) const
overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

std::string openstudio::contam::AfeCsf::name ( ) const
overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::AfeCsf::nr ( ) const
overridevirtual

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

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::AfeCsf::operator!= ( const AfeCsf other) const

Inequality operator.

AfeCsf& openstudio::contam::AfeCsf::operator= ( const AfeCsf other)

Copy operator.

bool openstudio::contam::AfeCsf::operator== ( const AfeCsf other) const

Equality operator.

void openstudio::contam::AfeCsf::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::AfeCsf::readDetails ( Reader input)

Read object details from a Reader.

void openstudio::contam::AfeCsf::setData ( const std::vector< XyDataPoint > &  data)

Sets the data point vector.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeCsf::setIcon ( const int  icon)
overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeCsf::setNr ( const int  nr)
overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeCsf::setU_x ( const int  u_x)

Sets the display units for x.

void openstudio::contam::AfeCsf::setU_y ( const int  u_y)

Sets the display units for y.

int openstudio::contam::AfeCsf::u_x ( ) const

Returns the display units for x.

int openstudio::contam::AfeCsf::u_y ( ) const

Returns the display units for y.

std::string openstudio::contam::AfeCsf::write ( )
overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.