olb::XMLreaderOutput Class Reference

#include <xmlReaderOutput.h>

Collaboration diagram for olb::XMLreaderOutput:

Public Member Functions
template<typename ParameterType >
void	parameterReading (std::vector< std::string > parameters, ParameterType &var, bool defaultAvailable, bool exitIfMissing, bool showWarning) const
void	loadFile (bool loadOK, std::string fName) const
void	readValue (bool warningsOn, std::string name, std::string fName) const
void	printWarning (std::string name, std::string typeName, std::string value, bool verboseOn, bool exitIfMissing) const
	print warning if verbose mode is on and exit, if exItMissing is true
template<typename XMLreaderType >
void	print (int indent, XMLreaderType &xmlReader) const
	printing the whole structure of the XMLreader
	XMLreaderOutput ()
	XMLreaderOutput (std::ostream &stream)
	XMLreaderOutput (OutputChannel outputChannel)

Protected Attributes
OstreamManager	clout
bool	_inDebugMode = false

Detailed Description

Definition at line 32 of file xmlReaderOutput.h.

Constructor & Destructor Documentation

XMLreaderOutput() [1/3]

olb::XMLreaderOutput::XMLreaderOutput ( )

inline

Definition at line 46 of file xmlReaderOutput.h.

: clout(std::cerr, "xmlReaderOutput"){}

XMLreaderOutput() [2/3]

olb::XMLreaderOutput::XMLreaderOutput ( std::ostream & stream )

inline

Definition at line 47 of file xmlReaderOutput.h.

: clout(stream, "xmlReaderOutput"){}

XMLreaderOutput() [3/3]

olb::XMLreaderOutput::XMLreaderOutput

(

OutputChannel

outputChannel

)

Definition at line 55 of file xmlReaderOutput.h.

                                                            : clout(std::cerr, "xmlReaderOutput"){
  if (outputChannel == OutputChannel::TERMINAL){
    clout = OstreamManager(std::cout, "xmlReaderOutput");
  }
  else if (outputChannel == OutputChannel::ERRCHANNEL){
    clout = OstreamManager(std::cerr, "xmlReaderOutput");
  } else{
    clout = OstreamManager(std::cerr, "xmlReaderOutput");
  }
#ifdef OLB_DEBUG
  _inDebugMode = true;
#endif
}

References _inDebugMode, clout, ERRCHANNEL, and TERMINAL.

Member Function Documentation

loadFile()

void olb::XMLreaderOutput::loadFile	(	bool	loadOK,
		std::string	fName ) const

Definition at line 99 of file xmlReaderOutput.h.

{
  if (!loadOK) {
    clout << std::string("Problem processing input XML file ") << fName << std::endl;
  }
}

References clout.

Here is the caller graph for this function:

parameterReading()

template<typename ParameterType >

void olb::XMLreaderOutput::parameterReading	(	std::vector< std::string >	parameters,
		ParameterType &	var,
		bool	defaultAvailable,
		bool	exitIfMissing,
		bool	showWarning ) const

Definition at line 70 of file xmlReaderOutput.h.

{
  if (showWarning || _inDebugMode) {
    clout << "Warning: Cannot read parameter from XML File: ";
    std::for_each(parameters.begin(), parameters.end(), [this](const std::string name_parameter)
      { clout << "<" << name_parameter << ">"; });
    clout << std::endl;
 
    if ( exitIfMissing ) {
      clout << "Error: This program cannot continue without ";
      std::for_each(parameters.begin(), parameters.end(), [this](const std::string name_parameter)
        { clout << "<" << name_parameter << ">"; });
      clout << ". Optimization aborted." << std::endl;
      exit(1);
    }
    if (defaultAvailable) {
      clout << "\t  Setting default value: " << parameters.back() << " = "<< var << std::endl;
    }
    else {
      clout << "\t  Setting arbitrarily: " << parameters.back() << " = " << var << std::endl;
    }
  }
}

References _inDebugMode, and clout.

Here is the caller graph for this function:

print()

template<typename XMLreaderType >

void olb::XMLreaderOutput::print	(	int	indent,
		XMLreaderType &	xmlReader ) const

printing the whole structure of the XMLreader

Definition at line 132 of file xmlReaderOutput.h.

                                                                     {
  std::string indentStr(indent, ' ');
  clout << indentStr << "[" << xmlReader.getName() << "]" << std::endl;
  if (!xmlReader.getText().empty()) {
    clout << indentStr << "  " << xmlReader.getText() << std::endl;
  }
  for (unsigned int iNode=0; iNode<xmlReader._children.size(); ++iNode) {
    xmlReader._children[iNode]->_output.print(indent+2,*xmlReader._children[iNode]);
  }
}

References clout.

printWarning()

void olb::XMLreaderOutput::printWarning	(	std::string	name,
		std::string	typeName,
		std::string	value,
		bool	verboseOn,
		bool	exitIfMissing ) const

print warning if verbose mode is on and exit, if exItMissing is true

Definition at line 114 of file xmlReaderOutput.h.

{
 
  if ( verboseOn ) {
    clout << "Warning: Cannot read " << typeName << " value from XML element " << name << "." << std::endl;
    if ( ! value.empty() ) {
      clout << "         Setting default value = " << value << std::endl;
    }
  }
  if ( exitIfMissing ) {
    clout << "Error: This program cannot continue without \"" << name << "\". Optimization aborted." << std::endl;
    exit(1);
  }
}

References clout.

Here is the caller graph for this function:

readValue()

void olb::XMLreaderOutput::readValue	(	bool	warningsOn,
		std::string	name,
		std::string	fName ) const

Definition at line 106 of file xmlReaderOutput.h.

{
  if ( warningsOn ) {
    clout << "Warning: cannot read value from node \"" << name << "\"" << ", \"" << fName <<"\"" << std::endl;
  }
}

References clout.

Here is the caller graph for this function:

Member Data Documentation

_inDebugMode

bool olb::XMLreaderOutput::_inDebugMode = false

protected

Definition at line 52 of file xmlReaderOutput.h.

clout

OstreamManager olb::XMLreaderOutput::clout

mutableprotected

Definition at line 51 of file xmlReaderOutput.h.

---

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

• src/io/xmlReaderOutput.h