OpenStudio:airflow
 All Classes Namespaces Functions Typedefs Enumerations Enumerator
List of all members
openstudio::contam::AfeSup Class Reference

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::AfeSup:

Public Member Functions

Constructors and Destructors
 AfeSup ()
 Create a new object with default values. More...
 
 AfeSup (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 AfeSup (int nr, int icon, std::string name, std::string desc, int sched, int u_H, std::vector< AirflowSubelementData > subelements)
 Create a new object. More...
 
 AfeSup (const AfeSup &other)
 Create a new object from another object. More...
 
 ~AfeSup ()=default
 Destroy the object. More...
 
Operators
AfeSupoperator= (const AfeSup &other)
 Copy operator. More...
 
bool operator== (const AfeSup &other) const
 Equality operator. More...
 
bool operator!= (const AfeSup &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 dataType () const override
 Returns the element data type. 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 sched () const
 Returns the scheduled sub-element number (only one). More...
 
void setSched (const int sched)
 Sets the scheduled sub-element number (only one). More...
 
int u_H () const
 Returns the display units of relative height. More...
 
void setU_H (const int u_H)
 Sets the display units of relative height. More...
 
std::vector
< AirflowSubelementData
subelements () const
 Returns the sub-element data vector. More...
 
void setSubelements (const std::vector< AirflowSubelementData > &subelements)
 Sets the sub-element data vector. More...
 
- Public Member Functions inherited from openstudio::contam::AirflowElement
virtual ~AirflowElement ()=default
 Destroy the object. More...
 

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. More...
 
static AirflowElementreadElement (Reader &input)
 Read an airflow element from a Reader object. More...
 

Detailed Description

The AfeSup object is an airflow element that combines multiple elements into a single element.

Constructor & Destructor Documentation

openstudio::contam::AfeSup::AfeSup ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::AfeSup::AfeSup ( int  nr,
int  icon,
std::string  name,
std::string  desc,
int  sched,
int  u_H,
std::vector< AirflowSubelementData subelements 
)

Create a new object.

openstudio::contam::AfeSup::AfeSup ( const AfeSup other)

Create a new object from another object.

openstudio::contam::AfeSup::~AfeSup ( )
default

Destroy the object.

Member Function Documentation

std::string openstudio::contam::AfeSup::dataType ( ) const
inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

int openstudio::contam::AfeSup::sched ( ) const

Returns the scheduled sub-element number (only one).

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeSup::setSched ( const int  sched)

Sets the scheduled sub-element number (only one).

void openstudio::contam::AfeSup::setSubelements ( const std::vector< AirflowSubelementData > &  subelements)

Sets the sub-element data vector.

void openstudio::contam::AfeSup::setU_H ( const int  u_H)

Sets the display units of relative height.

std::vector<AirflowSubelementData> openstudio::contam::AfeSup::subelements ( ) const

Returns the sub-element data vector.

int openstudio::contam::AfeSup::u_H ( ) const

Returns the display units of relative height.

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.