openstudio::contam::Level Class Reference

#include <PrjObjects.hpp>

Public Member Functions
Constructors and Destructors
	Level ()
	Create a new object with default values.
	Level (double delht, std::string name)
	Create a new object.
	Level (std::string delht, std::string name)
	Create a new object.
	Level (int nr, double refht, double delht, int u_rfht, int u_dlht, std::string name, std::vector< Icon > icons)
	Create a new object.
	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.
	Level (const Level &other)
	Create a new object from another object.
	~Level ()=default
	Destroy the object.
Operators
Level &	operator= (const Level &other)
	Copy operator.
bool	operator== (const Level &other) const
	Equality operator.
bool	operator!= (const Level &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
std::string	write ()
	Write the object to a string.
Getters and Setters
int	nr () const
	Returns the level number, in order from 1 to the number of levels.
void	setNr (const int nr)
	Sets the level number.
double	refht () const
	Returns the reference elevation of level [m].
bool	setRefht (const double refht)
	Sets the reference elevation of level [m].
bool	setRefht (const std::string &refht)
	Sets the reference elevation of level [m].
double	delht () const
	Returns the delta elevation to next level [m].
bool	setDelht (const double delht)
	Sets the delta elevation to next level [m].
bool	setDelht (const std::string &delht)
	Sets the delta elevation to next level [m].
int	u_rfht () const
	Returns the units of reference elevation.
void	setU_rfht (const int u_rfht)
	Returns the units of reference elevation.
int	u_dlht () const
	Returns the units of delta elevation.
void	setU_dlht (const int u_dlht)
	Sets the units of delta elevation.
std::string	name () const
	Returns the level name.
void	setName (const std::string &name)
	Sets the level name.
std::vector< Icon >	icons () const
	Returns the level's icons in a vector.
void	setIcons (const std::vector< Icon > &icons)
	Sets the level's icon vector.

Detailed Description

Level objects contain information about the levels that make up a CONTAM model.

Constructor & Destructor Documentation

Level() [1/6]

openstudio::contam::Level::Level

(

)

Create a new object with default values.

Level() [2/6]

openstudio::contam::Level::Level	(	double	delht,
		std::string	name )

Create a new object.

Level() [3/6]

openstudio::contam::Level::Level	(	std::string	delht,
		std::string	name )

Create a new object.

Level() [4/6]

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.

Level() [5/6]

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.

Level() [6/6]

openstudio::contam::Level::Level

(

const Level &

other

)

Create a new object from another object.

~Level()

openstudio::contam::Level::~Level ( )

default

Destroy the object.

Member Function Documentation

delht()

double openstudio::contam::Level::delht

(

)

const

Returns the delta elevation to next level [m].

icons()

std::vector< Icon > openstudio::contam::Level::icons

(

)

const

Returns the level's icons in a vector.

name()

std::string openstudio::contam::Level::name

(

)

const

Returns the level name.

nr()

int openstudio::contam::Level::nr

(

)

const

Returns the level number, in order from 1 to the number of levels.

operator!=()

bool openstudio::contam::Level::operator!=

(

const Level &

other

)

const

Inequality operator.

operator=()

Level & openstudio::contam::Level::operator=

(

const Level &

other

)

Copy operator.

operator==()

bool openstudio::contam::Level::operator==

(

const Level &

other

)

const

Equality operator.

read()

void openstudio::contam::Level::read

(

Reader &

input

)

Read an object from a Reader.

refht()

double openstudio::contam::Level::refht

(

)

const

Returns the reference elevation of level [m].

setDelht() [1/2]

bool openstudio::contam::Level::setDelht

(

const double

delht

)

Sets the delta elevation to next level [m].

setDelht() [2/2]

bool openstudio::contam::Level::setDelht

(

const std::string &

delht

)

Sets the delta elevation to next level [m].

setIcons()

void openstudio::contam::Level::setIcons

(

const std::vector< Icon > &

icons

)

Sets the level's icon vector.

setName()

void openstudio::contam::Level::setName

(

const std::string &

name

)

Sets the level name.

setNr()

void openstudio::contam::Level::setNr

(

const int

nr

)

Sets the level number.

This should only be done with care.

setRefht() [1/2]

bool openstudio::contam::Level::setRefht

(

const double

refht

)

Sets the reference elevation of level [m].

setRefht() [2/2]

bool openstudio::contam::Level::setRefht

(

const std::string &

refht

)

Sets the reference elevation of level [m].

setU_dlht()

void openstudio::contam::Level::setU_dlht

(

const int

u_dlht

)

Sets the units of delta elevation.

setU_rfht()

void openstudio::contam::Level::setU_rfht

(

const int

u_rfht

)

Returns the units of reference elevation.

u_dlht()

int openstudio::contam::Level::u_dlht

(

)

const

Returns the units of delta elevation.

u_rfht()

int openstudio::contam::Level::u_rfht

(

)

const

Returns the units of reference elevation.

write()

std::string openstudio::contam::Level::write

(

)

Write the object to a string.