OpenStudio:airflow
Loading...
Searching...
No Matches
openstudio::contam::AirflowSubelementData Class Reference

#include <PrjSubobjects.hpp>

Public Member Functions

Constructors
 AirflowSubelementData ()
 Create a new object with default values.
 
 AirflowSubelementData (int nr, double relHt, int filt)
 Create a new object.
 
 AirflowSubelementData (int nr, std::string relHt, int filt)
 Create a new object.
 
Input and Output
void read (Reader &reader)
 Read an object from a Reader.
 
std::string write ()
 Write the object to a string.
 

Getters and Setters

int nr () const
 Returns the sub-element number.
 
void setNr (const int nr)
 Sets the sub-element number.
 
double relHt () const
 Returns the relative height of the sub-element.
 
bool setRelHt (const double relHt)
 Sets the relative height of the sub-element.
 
bool setRelHt (const std::string &relHt)
 Sets the relative height of the sub-element.
 
int filt () const
 Returns the filtering flag: (1=filtered, 0=not).
 
void setFilt (const int filt)
 Sets the filtering flag (1=filtered, 0=not).
 

Detailed Description

The AirflowSubelementData object stores specific details for an airflow element that is part of a super element.

Constructor & Destructor Documentation

◆ AirflowSubelementData() [1/3]

openstudio::contam::AirflowSubelementData::AirflowSubelementData ( )

Create a new object with default values.

◆ AirflowSubelementData() [2/3]

openstudio::contam::AirflowSubelementData::AirflowSubelementData ( int nr,
double relHt,
int filt )

Create a new object.

◆ AirflowSubelementData() [3/3]

openstudio::contam::AirflowSubelementData::AirflowSubelementData ( int nr,
std::string relHt,
int filt )

Create a new object.

Member Function Documentation

◆ filt()

int openstudio::contam::AirflowSubelementData::filt ( ) const

Returns the filtering flag: (1=filtered, 0=not).

◆ nr()

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

Returns the sub-element number.

◆ read()

void openstudio::contam::AirflowSubelementData::read ( Reader & reader)

Read an object from a Reader.

◆ relHt()

double openstudio::contam::AirflowSubelementData::relHt ( ) const

Returns the relative height of the sub-element.

◆ setFilt()

void openstudio::contam::AirflowSubelementData::setFilt ( const int filt)

Sets the filtering flag (1=filtered, 0=not).

◆ setNr()

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

Sets the sub-element number.

◆ setRelHt() [1/2]

bool openstudio::contam::AirflowSubelementData::setRelHt ( const double relHt)

Sets the relative height of the sub-element.

◆ setRelHt() [2/2]

bool openstudio::contam::AirflowSubelementData::setRelHt ( const std::string & relHt)

Sets the relative height of the sub-element.

◆ write()

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

Write the object to a string.