olb::XMLreader Class Reference

#include <xmlReader.h>

Collaboration diagram for olb::XMLreader:

Public Member Functions
	XMLreader (TiXmlNode *pParent, OutputChannel outputChannel=OutputChannel::ERRCHANNEL)
	Constructs a new XMLreader from another XMLreader.
	XMLreader (const std::string &fName, OutputChannel outputChannel=OutputChannel::ERRCHANNEL)
	Constructs a new XMLreader from a XML file fName.
	~XMLreader ()
	destructor
template<typename T >
bool	read (T &value, bool verboseOn=true, bool exitIfMissing=false) const
	Prints out the XML structure read in, mostly for debugging purposes.
template<typename T , unsigned DIM>
bool	read (util::ADf< T, DIM > &value, bool verboseOn=true, bool exitIfMissing=false) const
template<typename T >
bool	read (std::vector< T > &value, bool verboseOn=true, bool exitIfMissing=false) const
template<typename T >
T	get (bool verboseOn=true, bool exitIfMissing=false) const
template<typename ParameterType >
bool	readOrWarn (std::string name_parameter_1, std::string name_parameter_2, std::string name_parameter_3, ParameterType &var, bool defaultAvailable=true, bool exitIfMissing=false, bool showWarning=true) const
	This wrapper function reads the given parameter from the "type_parameter" and "name_parameter_1" or "name_parameter_2" tag and prints a warning, if the parameter can not be read.
template<typename ParameterType >
bool	readOrWarn (std::string name_parameter_1, std::string name_parameter_2, std::string name_parameter_3, std::string name_parameter_4, ParameterType &var, bool defaultAvailable=true, bool exitIfMissing=false, bool showWarning=true) const
XMLreader const &	operator[] (std::string name) const
std::vector< XMLreader * >::const_iterator	begin () const
	Returns an iterator.begin() of the child XMLreader This means an iterator to the next level on an XML tree.
std::vector< XMLreader * >::const_iterator	end () const
	Returns an iterator.end() of the child XMLreader This means an iterator to the next level on an XML tree.
void	setWarningsOn (bool warnings) const
	switch warnings on/off
std::string	getName () const
	return the name of the element
std::string	getText () const
	return the text of the element
std::string	getAttribute (const std::string &aName) const
template<>
bool	read (bool &value, bool verboseOn, bool exitIfMissing) const
template<>
bool	read (int &value, bool verboseOn, bool exitIfMissing) const
template<>
bool	read (double &value, bool verboseOn, bool exitIfMissing) const
template<>
bool	read (long double &value, bool verboseOn, bool exitIfMissing) const
template<>
bool	read (float &value, bool verboseOn, bool exitIfMissing) const

Public Attributes
XMLreaderOutput	_output
	handling all the output for the XMLreader

Protected Attributes
std::map< std::string, std::string >	_attributes
std::vector< XMLreader * >	_children

Friends
class	olb::XMLreaderOutput

Detailed Description

Definition at line 49 of file xmlReader.h.

Constructor & Destructor Documentation

XMLreader() [1/2]

olb::XMLreader::XMLreader	(	TiXmlNode *	pParent,
		OutputChannel	outputChannel = OutputChannel::ERRCHANNEL )

Constructs a new XMLreader from another XMLreader.

Parameters

pParent

The new root node for the XMLreader

Definition at line 244 of file xmlReader.h.

                                                                     : _output(outputChannel)
{
  _outputChannel = outputChannel;
  _warningsOn = true;
 
  if (singleton::mpi().isMainProcessor()) {
    mainProcessorIni(pParent);
  }
  else {
    slaveProcessorIni();
  }
}

References olb::singleton::mpi().

Here is the call graph for this function:

XMLreader() [2/2]

olb::XMLreader::XMLreader	(	const std::string &	fName,
		OutputChannel	outputChannel = OutputChannel::ERRCHANNEL )

Constructs a new XMLreader from a XML file fName.

Definition at line 257 of file xmlReader.h.

                                                                        : _output(outputChannel)
{
  _outputChannel = outputChannel;
  _warningsOn = true;
 
  TiXmlDocument* doc = nullptr;
  int loadOK = false;
#ifdef PARALLEL_MODE_MPI  // parallel program execution
  if (singleton::mpi().isMainProcessor()) {
#endif
    std::string docName = std::string(fName);  // call copy constructor
    doc = new TiXmlDocument(docName.c_str());
    loadOK = doc->LoadFile();
    _output.loadFile(loadOK, fName);
#ifdef PARALLEL_MODE_MPI  // parallel program execution
  }
  if (singleton::mpi().isMainProcessor()) {
#endif
    mainProcessorIni(doc);
    delete doc;
#ifdef PARALLEL_MODE_MPI  // parallel program execution
  }
  else {
    slaveProcessorIni();
  }
#endif
}

References _output, olb::XMLreaderOutput::loadFile(), and olb::singleton::mpi().

Here is the call graph for this function:

~XMLreader()

olb::XMLreader::~XMLreader

(

)

destructor

Definition at line 285 of file xmlReader.h.

{
  for (unsigned int iNode=0; iNode<_children.size(); ++iNode) {
    delete _children[iNode];
  }
}

References _children.

Member Function Documentation

begin()

std::vector< XMLreader * >::const_iterator olb::XMLreader::begin

(

)

const

Returns an iterator.begin() of the child XMLreader This means an iterator to the next level on an XML tree.

Definition at line 392 of file xmlReader.h.

{
  return _children.begin();
}

References _children, and begin().

Here is the call graph for this function:

Here is the caller graph for this function:

end()

std::vector< XMLreader * >::const_iterator olb::XMLreader::end

(

)

const

Returns an iterator.end() of the child XMLreader This means an iterator to the next level on an XML tree.

Definition at line 397 of file xmlReader.h.

{
  return _children.end();
}

References _children.

Here is the caller graph for this function:

get()

template<typename T >

T olb::XMLreader::get	(	bool	verboseOn = true,
		bool	exitIfMissing = false ) const

Definition at line 163 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  T tmp = T();
  if (!(valueStr >> tmp)) {
//    if ( verboseOn ) {
//      clout << "Error: cannot read value from XML element " << _name << std::endl;
//    }
    _output.printWarning(_name, typeid(T).name(), "", verboseOn, exitIfMissing);
  }
  return tmp;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

getAttribute()

std::string olb::XMLreader::getAttribute

(

const std::string &

aName

)

const

Returns

the value of attribute

Definition at line 541 of file xmlReader.h.

{
  std::map<std::string, std::string>::const_iterator it = _attributes.find(aName);
  if ( it == _attributes.end()) {
    return "Attribute not found.";
  }
  return it->second;
  //return attributes[aName];
}

References _attributes.

Here is the caller graph for this function:

getName()

std::string olb::XMLreader::getName

(

)

const

return the name of the element

Definition at line 402 of file xmlReader.h.

{
  return _name;
}

Here is the caller graph for this function:

getText()

std::string olb::XMLreader::getText

(

)

const

return the text of the element

Definition at line 407 of file xmlReader.h.

{
  return _text;
}

operator[]()

XMLreader const & olb::XMLreader::operator[]

(

std::string

name

)

const

Returns

a Subtree placed at name

Parameters

name	The name from which to take the subtree

Definition at line 381 of file xmlReader.h.

{
  for (unsigned int iNode=0; iNode<_children.size(); ++iNode) {
    if (_children[iNode]->_name == fName) {
      return *_children[iNode];
    }
  }
  _output.readValue(_warningsOn, _name, fName);
  return _notFound;
}

References _children, _output, and olb::XMLreaderOutput::readValue().

Here is the call graph for this function:

read() [1/8]

template<>

bool olb::XMLreader::read	(	bool &	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

Definition at line 422 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  std::string word;
  valueStr >> word;
  // Transform to lower-case, so that "true" and "false" are case-insensitive.
  std::transform(word.begin(), word.end(), word.begin(), ::tolower);
  if (!word.compare("true") || (word=="1")) {
    value = true;
    return true;
  }
  else if (!word.compare("false") || (word=="0")) {
    value=false;
    return true;
  }
  else {
    if ( verboseOn ) {
      std::stringstream ss;
      ss << ( value ? "true" : "false" );
      _output.printWarning(_name, "bool", ss.str(),  verboseOn, exitIfMissing);
    }
  }
  return false;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [2/8]

template<>

bool olb::XMLreader::read	(	double &	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

Definition at line 481 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  double tmp = double();
  if (!(valueStr >> tmp)) {
    _output.printWarning(_name, "double", std::to_string(value), verboseOn, exitIfMissing);
    return false;
  }
  value = tmp;
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [3/8]

template<>

bool olb::XMLreader::read	(	float &	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

Definition at line 508 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  float tmp = float();
  if (!(valueStr >> tmp)) {
    std::stringstream ss;
    ss << value;
    _output.printWarning(_name, "float", ss.str(), verboseOn, exitIfMissing);
    return false;
  }
  value = tmp;
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [4/8]

template<>

bool olb::XMLreader::read	(	int &	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

Definition at line 449 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  int tmp = int();
  if (!(valueStr >> tmp)) {
    std::stringstream ss;
    ss << value;
    _output.printWarning(_name, "int", ss.str(), verboseOn, exitIfMissing);
    return false;
  }
  value = tmp;
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [5/8]

template<>

bool olb::XMLreader::read	(	long double &	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

Definition at line 495 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  std::string tmp {};
  if (!(valueStr >> tmp)) {
    _output.printWarning(_name, "long double", std::to_string(value), verboseOn, exitIfMissing);
    return false;
  }
  value = std::stold(tmp);
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [6/8]

template<typename T >

bool olb::XMLreader::read	(	std::vector< T > &	value,
		bool	verboseOn = true,
		bool	exitIfMissing = false ) const

Definition at line 141 of file xmlReader.h.

{
  std::stringstream multiValueStr(_text);
  std::string word;
  std::vector<T> tmp(values);
  while (multiValueStr>>word) {
    std::stringstream valueStr(word);
    T value;
    if (!(valueStr >> value)) {
//      if ( verboseOn ) {
//        clout << std::string("Error: cannot read value array from XML element ") << _name << std::endl;
//      }
      _output.printWarning(_name, "std::vector", "", verboseOn, exitIfMissing);
      return false;
    }
    tmp.push_back(value);
  }
  values.swap(tmp);
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

read() [7/8]

template<typename T >

bool olb::XMLreader::read	(	T &	value,
		bool	verboseOn = true,
		bool	exitIfMissing = false ) const

Prints out the XML structure read in, mostly for debugging purposes.

Read a value from the xml file

Parameters

reference

to return the value

Returns

returns the value

Here is the caller graph for this function:

read() [8/8]

template<typename T , unsigned DIM>

bool olb::XMLreader::read	(	util::ADf< T, DIM > &	value,
		bool	verboseOn = true,
		bool	exitIfMissing = false ) const

Definition at line 125 of file xmlReader.h.

{
  std::stringstream valueStr(_text);
  T tmp = T();
  if (!(valueStr >> tmp)) {
//    if ( _verboseOn ) {
//      clout << std::string("Error: cannot read value from XML element ") << _name << std::endl;
//    }
    _output.printWarning(_name, "ADf vector", "", verboseOn, exitIfMissing);
    return false;
  }
  value = util::ADf<T,DIM>(tmp);
  return true;
}

References _output, and olb::XMLreaderOutput::printWarning().

Here is the call graph for this function:

readOrWarn() [1/2]

template<typename ParameterType >

bool olb::XMLreader::readOrWarn	(	std::string	name_parameter_1,
		std::string	name_parameter_2,
		std::string	name_parameter_3,
		ParameterType &	var,
		bool	defaultAvailable = true,
		bool	exitIfMissing = false,
		bool	showWarning = true ) const

This wrapper function reads the given parameter from the "type_parameter" and "name_parameter_1" or "name_parameter_2" tag and prints a warning, if the parameter can not be read.

The warning contains the default value, if available. Will exit(1) if exitIfMissing == true. The warning is not displayed, if showWarning == false.

Definition at line 178 of file xmlReader.h.

{
  // deactivate default warnings and show default values instead
  setWarningsOn(false);
  if (name_parameter_3 == "") {
    if (!(*this)[name_parameter_1][name_parameter_2].read<ParameterType>(var, false)) {
      _output.parameterReading({name_parameter_1, name_parameter_2}, var, defaultAvailable, exitIfMissing, showWarning);
      return false;
    }
    return true;
  }
  else{
    if (!(*this)[name_parameter_1][name_parameter_2][name_parameter_3].read<ParameterType>(var, false)) {
      _output.parameterReading({name_parameter_1, name_parameter_2, name_parameter_3}, var, defaultAvailable, exitIfMissing, showWarning);
      return false;
    }
    return true;
  }
  // turn default warnings on again
  setWarningsOn(true);
}

References _output, olb::XMLreaderOutput::parameterReading(), and setWarningsOn().

Here is the call graph for this function:

Here is the caller graph for this function:

readOrWarn() [2/2]

template<typename ParameterType >

bool olb::XMLreader::readOrWarn	(	std::string	name_parameter_1,
		std::string	name_parameter_2,
		std::string	name_parameter_3,
		std::string	name_parameter_4,
		ParameterType &	var,
		bool	defaultAvailable = true,
		bool	exitIfMissing = false,
		bool	showWarning = true ) const

Returns

a Subtree placed at name

Parameters

name	The name from which to take the subtree

Definition at line 203 of file xmlReader.h.

{
  // deactivate default warnings and show default values instead
  setWarningsOn(false);
  if (name_parameter_3 == "") {
    if (!(*this)[name_parameter_1][name_parameter_2].read<ParameterType>(var, false)) {
      _output.parameterReading({name_parameter_1, name_parameter_2}, var, defaultAvailable, exitIfMissing, showWarning);
      return false;
    }
    return true;
  }
  else if(name_parameter_4 == ""){
    if (!(*this)[name_parameter_1][name_parameter_2][name_parameter_3].read<ParameterType>(var, false)) {
      _output.parameterReading({name_parameter_1, name_parameter_2, name_parameter_3}, var, defaultAvailable, exitIfMissing, showWarning);
      return false;
    }
    return true;
  }
  else {
    if (!(*this)[name_parameter_1][name_parameter_2][name_parameter_3][name_parameter_4].read<ParameterType>(var, false)) {
      _output.parameterReading({name_parameter_1, name_parameter_2,name_parameter_3,name_parameter_4},
                                    var, defaultAvailable, exitIfMissing, showWarning);
      return false;
    }
    return true;
  }
  // turn default warnings on again
  setWarningsOn(true);
}

References _output, olb::XMLreaderOutput::parameterReading(), and setWarningsOn().

Here is the call graph for this function:

setWarningsOn()

void olb::XMLreader::setWarningsOn

(

bool

warnings

)

const

switch warnings on/off

Definition at line 412 of file xmlReader.h.

{
  _warningsOn = warnings;
  for (unsigned int iNode=0; iNode<_children.size(); ++iNode) {
    _children[iNode]->setWarningsOn(warnings);
  }
}

References _children.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

olb::XMLreaderOutput

friend class olb::XMLreaderOutput

friend

Definition at line 50 of file xmlReader.h.

Member Data Documentation

_attributes

std::map<std::string, std::string> olb::XMLreader::_attributes

protected

Definition at line 118 of file xmlReader.h.

_children

std::vector<XMLreader*> olb::XMLreader::_children

protected

Definition at line 119 of file xmlReader.h.

_output

XMLreaderOutput olb::XMLreader::_output

handling all the output for the XMLreader

Definition at line 106 of file xmlReader.h.

---

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

• src/io/xmlReader.h