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

#include <PrjObjects.hpp>

Public Member Functions

Constructors and Destructors
 Ahs ()
 Create a new object with default values. More...
 
 Ahs (int nr, int zone_r, int zone_s, int path_r, int path_s, int path_x, std::string name, std::string desc)
 Create a new object. More...
 
 Ahs (const Ahs &other)
 Create a new object from another object. More...
 
 ~Ahs ()
 Destroy the object. More...
 
Operators
Ahsoperator= (const Ahs &other)
 Copy operator. More...
 
bool operator== (const Ahs &other) const
 Equality operator. More...
 
bool operator!= (const Ahs &other) const
 Inequality operator. More...
 
Input and Output
void read (Reader &input)
 Read an object from a Reader. More...
 
std::string write ()
 Write the object to a string. More...
 
Getters and Setters
int nr () const
 Returns the AHS number, in order from 1 to the number of systems. More...
 
void setNr (const int nr)
 Sets the AHS number. More...
 
int zone_r () const
 Returns the return zone number. More...
 
void setZone_r (const int zone_r)
 Sets the return zone number. More...
 
int zone_s () const
 Returns the supply zone number. More...
 
void setZone_s (const int zone_s)
 Sets the supply zone number. More...
 
int path_r () const
 Returns the recirculation air path number. More...
 
void setPath_r (const int path_r)
 Sets the recirculation air path number. More...
 
int path_s () const
 Returns the outdoor air path number. More...
 
void setPath_s (const int path_s)
 Sets the outdoor air path number. More...
 
int path_x () const
 Returns the exhaust path number. More...
 
void setPath_x (const int path_x)
 Sets the exhaust path number. More...
 
std::string name () const
 Returns the AHS name. More...
 
void setName (const std::string &name)
 Sets the AHS name. More...
 
std::string desc () const
 Returns the AHS description. More...
 
void setDesc (const std::string &desc)
 Sets the AHS description. More...
 

Detailed Description

Ahs is a class that represents CONTAM's simple air handling system.

These objects should be constructed after all paths have been added to the model.

Constructor & Destructor Documentation

openstudio::contam::Ahs::Ahs ( )

Create a new object with default values.

openstudio::contam::Ahs::Ahs ( int  nr,
int  zone_r,
int  zone_s,
int  path_r,
int  path_s,
int  path_x,
std::string  name,
std::string  desc 
)

Create a new object.

openstudio::contam::Ahs::Ahs ( const Ahs other)

Create a new object from another object.

openstudio::contam::Ahs::~Ahs ( )

Destroy the object.

Member Function Documentation

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

Returns the AHS description.

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

Returns the AHS name.

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

Returns the AHS number, in order from 1 to the number of systems.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

int openstudio::contam::Ahs::path_r ( ) const

Returns the recirculation air path number.

int openstudio::contam::Ahs::path_s ( ) const

Returns the outdoor air path number.

int openstudio::contam::Ahs::path_x ( ) const

Returns the exhaust path number.

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

Read an object from a Reader.

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

Sets the AHS description.

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

Sets the AHS name.

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

Sets the AHS number.

This should only be done with care.

void openstudio::contam::Ahs::setPath_r ( const int  path_r)

Sets the recirculation air path number.

void openstudio::contam::Ahs::setPath_s ( const int  path_s)

Sets the outdoor air path number.

void openstudio::contam::Ahs::setPath_x ( const int  path_x)

Sets the exhaust path number.

void openstudio::contam::Ahs::setZone_r ( const int  zone_r)

Sets the return zone number.

void openstudio::contam::Ahs::setZone_s ( const int  zone_s)

Sets the supply zone number.

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

Write the object to a string.

int openstudio::contam::Ahs::zone_r ( ) const

Returns the return zone number.

int openstudio::contam::Ahs::zone_s ( ) const

Returns the supply zone number.