ReportEngine Class Reference

Final class and should not be derived. More...

Collaboration diagram for ReportEngine:

Public Member Functions
	ReportEngine (const std::string &cname, const std::string &fname)
	~ReportEngine ()
void	flush ()
void	warning (const std::string &msg)
void	error (const std::string &msg, bool fatal=false)
void	echo (xmlNodePtr cur, bool recursive=false)

Static Public Member Functions
static void	enableOutput ()

Private Member Functions
	ReportEngine (const ReportEngine &a)

Private Attributes
std::string	ClassName
	class Name More...
std::string	FuncName
	name of the current member function More...
std::vector< std::string >	ArgList
	arguments More...
InfoStream &	LogBuffer
	stream for log message More...

Static Private Attributes
static bool	DoOutput = false

Detailed Description

Final class and should not be derived.

Definition at line 33 of file ProgressReportEngine.h.

Constructor & Destructor Documentation

ReportEngine() [1/2]

ReportEngine ( const std::string &  cname, const std::string &  fname  )

inline

Definition at line 36 of file ProgressReportEngine.h.

References ReportEngine::ClassName, ReportEngine::DoOutput, InfoStream::flush(), ReportEngine::FuncName, and ReportEngine::LogBuffer.

      : ClassName(cname), FuncName(fname), LogBuffer(infoDebug)
  {
    if (DoOutput)
    {
      LogBuffer << "  " << ClassName << "::" << FuncName << '\n';
      LogBuffer.flush(); //always flush
    }
  }

~ReportEngine()

~ReportEngine ( )

inline

Definition at line 46 of file ProgressReportEngine.h.

References InfoStream::flush(), and ReportEngine::LogBuffer.

  {
    LogBuffer.flush();
  }

ReportEngine() [2/2]

ReportEngine ( const ReportEngine &  a )

inlineprivate

Definition at line 87 of file ProgressReportEngine.h.

: LogBuffer(infoDebug) {}

Member Function Documentation

echo()

void echo	(	xmlNodePtr	cur,
		bool	recursive = false
	)

Definition at line 20 of file ProgressReportEngine.cpp.

References app_debug.

Referenced by AOBasisBuilder< COT >::put().

{
  if (cur == nullptr)
    return;
  app_debug() << R"(<input node=")" << (const char*)(cur->name) << '"';
  xmlAttrPtr att = cur->properties;
  while (att != nullptr)
  {
    app_debug() << "  " << (const char*)(att->name) << R"(=")" << (const char*)(att->children->content) << '"';
    att = att->next;
  }
  app_debug() << R"(/>\n)";
}

enableOutput()

static void enableOutput ( )

inlinestatic

Definition at line 71 of file ProgressReportEngine.h.

References ReportEngine::DoOutput.

Referenced by main().

{ DoOutput = true; }

error()

void error ( const std::string &  msg, bool  fatal = false  )

inline

Definition at line 62 of file ProgressReportEngine.h.

References APP_ABORT, qmcplusplus::app_error(), ReportEngine::ClassName, and ReportEngine::FuncName.

Referenced by SlaterDetBuilder::buildComponent(), JastrowBuilder::buildOneBody(), AOBasisBuilder< COT >::createAOSetH5(), LCAOrbitalBuilder::createBasisSet(), LCAOrbitalBuilder::createBasisSetH5(), RadialJastrowBuilder::createJ1(), RadialJastrowBuilder::createJ2(), SPOSetBuilderFactory::createSPOSetBuilder(), ShortRangeCuspFunctor< T >::evaluate(), BsplineFunctor< REAL >::initialize(), LCAOrbitalBuilder::loadBasisSetFromH5(), LCAOrbitalBuilder::loadBasisSetFromXML(), HamiltonianPool::put(), BsplineFunctor< REAL >::put(), ShortRangeCuspFunctor< T >::put(), PolynomialFunctor3D::put(), and ShortRangeCuspFunctor< T >::set_variable_from_xml().

  {
    app_error() << ("ERROR: " + msg + '\n');
    if (fatal)
      APP_ABORT(ClassName + "::" + FuncName);
  }

flush()

void flush ( )

inline

Definition at line 51 of file ProgressReportEngine.h.

References ReportEngine::DoOutput, InfoStream::flush(), and ReportEngine::LogBuffer.

Referenced by SPOSetBuilderFactory::createSPOSetBuilder().

  {
    if (DoOutput)
    {
      LogBuffer << '\n';
      LogBuffer.flush();
    }
  }

warning()

void warning ( const std::string &  msg )

inline

Definition at line 60 of file ProgressReportEngine.h.

References ReportEngine::LogBuffer.

Referenced by RadialJastrowBuilder::createJ2().

{ LogBuffer << ("WARNING: " + msg + '\n'); }

Member Data Documentation

ArgList

std::vector<std::string> ArgList

private

arguments

Definition at line 82 of file ProgressReportEngine.h.

ClassName

std::string ClassName

private

class Name

Definition at line 76 of file ProgressReportEngine.h.

Referenced by ReportEngine::error(), and ReportEngine::ReportEngine().

DoOutput

bool DoOutput = false

staticprivate

Definition at line 89 of file ProgressReportEngine.h.

Referenced by ReportEngine::enableOutput(), ReportEngine::flush(), and ReportEngine::ReportEngine().

FuncName

std::string FuncName

private

name of the current member function

Definition at line 79 of file ProgressReportEngine.h.

Referenced by ReportEngine::error(), and ReportEngine::ReportEngine().

LogBuffer

InfoStream& LogBuffer

private

stream for log message

Definition at line 85 of file ProgressReportEngine.h.

Referenced by ReportEngine::flush(), ReportEngine::ReportEngine(), ReportEngine::warning(), and ReportEngine::~ReportEngine().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Utilities/ProgressReportEngine.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Utilities/ProgressReportEngine.cpp