coupling::configurations::ThermostatConfiguration Class Reference

#include <ThermostatConfiguration.h>

Inheritance diagram for coupling::configurations::ThermostatConfiguration:

Collaboration diagram for coupling::configurations::ThermostatConfiguration:

Public Types
enum	ThermostatRegion {   onlyOutestLayer , outerLayers , all , nowhere ,   none }

Public Member Functions
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
ThermostatRegion	getThermostatRegionType () const
unsigned int	getCells2Use () const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Protected Member Functions
	ThermostatConfiguration (ThermostatRegion type)

Private Attributes
ThermostatRegion	_type
int	_cells {0}
bool	_isValid

Detailed Description

reads the configuartion for the domain of the thermostat.

Author

Helene Wittenberg

Member Function Documentation

getTag()

std::string coupling::configurations::ThermostatConfiguration::getTag ( ) const

inlinevirtual

Return name of xml tag that is associated to the configuration.

Implements tarch::configuration::Configuration.

isValid()

bool coupling::configurations::ThermostatConfiguration::isValid ( ) const

inlinevirtual

Is config valid?

This operation usually fails, if

• parseSubtag() hasn't been called, i.e. configuration has not been used, or
• parseSubtag() failed due to a wrong file.

If a tag ain't optional and parseSubtag() was not called (first case)

Implements tarch::configuration::Configuration.

parseSubtag()

void coupling::configurations::ThermostatConfiguration::parseSubtag ( tinyxml2::XMLElement * node )

inlinevirtual

Parses a XML-element.

Parameters

node	a pointer to the xml-element from tinyxml2 class

Implements tarch::configuration::Configuration.

---

The documentation for this class was generated from the following file:

• coupling/configurations/ThermostatConfiguration.h