 |
OpenStudioCore:airflow |
#include <PrjObjects.hpp>
Public Member Functions | |
Constructors and Destructors | |
| Level () | |
| Create a new object with default values. More... | |
| Level (double delht, std::string name) | |
| Create a new object. More... | |
| Level (std::string delht, std::string name) | |
| Create a new object. More... | |
| Level (int nr, double refht, double delht, int u_rfht, int u_dlht, std::string name, std::vector< Icon > icons) | |
| Create a new object. More... | |
| Level (int nr, std::string refht, std::string delht, int u_rfht, int u_dlht, std::string name, std::vector< Icon > icons) | |
| Create a new object. More... | |
| Level (const Level &other) | |
| Create a new object from another object. More... | |
| ~Level () | |
| Destroy the object. More... | |
Operators | |
| Level & | operator= (const Level &other) |
| Copy operator. More... | |
| bool | operator== (const Level &other) const |
| Equality operator. More... | |
| bool | operator!= (const Level &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 level number, in order from 1 to the number of levels. More... | |
| void | setNr (const int nr) |
| Sets the level number. More... | |
| double | refht () const |
| Returns the reference elevation of level [m]. More... | |
| bool | setRefht (const double refht) |
| Sets the reference elevation of level [m]. More... | |
| bool | setRefht (const std::string &refht) |
| Sets the reference elevation of level [m]. More... | |
| double | delht () const |
| Returns the delta elevation to next level [m]. More... | |
| bool | setDelht (const double delht) |
| Sets the delta elevation to next level [m]. More... | |
| bool | setDelht (const std::string &delht) |
| Sets the delta elevation to next level [m]. More... | |
| int | u_rfht () const |
| Returns the units of reference elevation. More... | |
| void | setU_rfht (const int u_rfht) |
| Returns the units of reference elevation. More... | |
| int | u_dlht () const |
| Returns the units of delta elevation. More... | |
| void | setU_dlht (const int u_dlht) |
| Sets the units of delta elevation. More... | |
| std::string | name () const |
| Returns the level name. More... | |
| void | setName (const std::string &name) |
| Sets the level name. More... | |
| std::vector< Icon > | icons () const |
| Returns the level's icons in a vector. More... | |
| void | setIcons (const std::vector< Icon > &icons) |
| Sets the level's icon vector. More... | |
Level objects contain information about the levels that make up a CONTAM model.
| openstudio::contam::Level::Level | ( | ) |
Create a new object with default values.
| openstudio::contam::Level::Level | ( | double | delht, |
| std::string | name | ||
| ) |
Create a new object.
| openstudio::contam::Level::Level | ( | std::string | delht, |
| std::string | name | ||
| ) |
Create a new object.
| openstudio::contam::Level::Level | ( | int | nr, |
| double | refht, | ||
| double | delht, | ||
| int | u_rfht, | ||
| int | u_dlht, | ||
| std::string | name, | ||
| std::vector< Icon > | icons | ||
| ) |
Create a new object.
| openstudio::contam::Level::Level | ( | int | nr, |
| std::string | refht, | ||
| std::string | delht, | ||
| int | u_rfht, | ||
| int | u_dlht, | ||
| std::string | name, | ||
| std::vector< Icon > | icons | ||
| ) |
Create a new object.
| openstudio::contam::Level::Level | ( | const Level & | other | ) |
Create a new object from another object.
| openstudio::contam::Level::~Level | ( | ) |
Destroy the object.
| double openstudio::contam::Level::delht | ( | ) | const |
Returns the delta elevation to next level [m].
| std::vector<Icon> openstudio::contam::Level::icons | ( | ) | const |
Returns the level's icons in a vector.
| std::string openstudio::contam::Level::name | ( | ) | const |
Returns the level name.
| int openstudio::contam::Level::nr | ( | ) | const |
Returns the level number, in order from 1 to the number of levels.
| bool openstudio::contam::Level::operator!= | ( | const Level & | other | ) | const |
Inequality operator.
| bool openstudio::contam::Level::operator== | ( | const Level & | other | ) | const |
Equality operator.
| double openstudio::contam::Level::refht | ( | ) | const |
Returns the reference elevation of level [m].
| bool openstudio::contam::Level::setDelht | ( | const double | delht | ) |
Sets the delta elevation to next level [m].
| bool openstudio::contam::Level::setDelht | ( | const std::string & | delht | ) |
Sets the delta elevation to next level [m].
| void openstudio::contam::Level::setIcons | ( | const std::vector< Icon > & | icons | ) |
Sets the level's icon vector.
| void openstudio::contam::Level::setName | ( | const std::string & | name | ) |
Sets the level name.
| void openstudio::contam::Level::setNr | ( | const int | nr | ) |
Sets the level number.
This should only be done with care.
| bool openstudio::contam::Level::setRefht | ( | const double | refht | ) |
Sets the reference elevation of level [m].
| bool openstudio::contam::Level::setRefht | ( | const std::string & | refht | ) |
Sets the reference elevation of level [m].
| void openstudio::contam::Level::setU_dlht | ( | const int | u_dlht | ) |
Sets the units of delta elevation.
| void openstudio::contam::Level::setU_rfht | ( | const int | u_rfht | ) |
Returns the units of reference elevation.
| int openstudio::contam::Level::u_dlht | ( | ) | const |
Returns the units of delta elevation.
| int openstudio::contam::Level::u_rfht | ( | ) | const |
Returns the units of reference elevation.
| std::string openstudio::contam::Level::write | ( | ) |
Write the object to a string.