ProgressReportEngine.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////////////////////
// This file is distributed under the University of Illinois/NCSA Open Source License.
// See LICENSE file in top directory for details.
//
// Copyright (c) 2016 Jeongnim Kim and QMCPACK developers.
//
// File developed by: Jeremy McMinnis, jmcminis@gmail.com, University of Illinois at Urbana-Champaign
//                    Jeongnim Kim, jeongnim.kim@gmail.com, University of Illinois at Urbana-Champaign
//                    Mark Dewing, markdewing@gmail.com, University of Illinois at Urbana-Champaign
//
// File created by: Jeongnim Kim, jeongnim.kim@gmail.com, University of Illinois at Urbana-Champaign
//////////////////////////////////////////////////////////////////////////////////////


/** @file ProgressReportEngine.h
 * @brief declaration of ProgressReportEngine
 */

#ifndef QMCPLUSPLUS_PROGRESSREPORTENGINE_H
#define QMCPLUSPLUS_PROGRESSREPORTENGINE_H

#include "Platforms/Host/OutputManager.h"
#include "Message/Communicate.h"
#include "Utilities/Timer.h"
#include "OhmmsData/OhmmsElementBase.h"

namespace qmcplusplus
{
/**
 *
 * Final class and should not be derived.
 */
class ReportEngine
{
public:
  inline ReportEngine(const std::string& cname, const std::string& fname)
      : ClassName(cname), FuncName(fname), LogBuffer(infoDebug)
  {
    if (DoOutput)
    {
      LogBuffer << "  " << ClassName << "::" << FuncName << '\n';
      LogBuffer.flush(); //always flush
    }
  }

  inline ~ReportEngine()
  {
    LogBuffer.flush();
  }

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

  inline void warning(const std::string& msg) { LogBuffer << ("WARNING: " + msg + '\n'); }

  inline void error(const std::string& msg, bool fatal = false)
  {
    app_error() << ("ERROR: " + msg + '\n');
    if (fatal)
      APP_ABORT(ClassName + "::" + FuncName);
  }

  void echo(xmlNodePtr cur, bool recursive = false);

  static void enableOutput() { DoOutput = true; }

private:
  /** class Name
   */
  std::string ClassName;
  /** name of the current  member function
   */
  std::string FuncName;
  /** arguments
   */
  std::vector<std::string> ArgList;
  /** stream for log message
   */
  InfoStream& LogBuffer;
  //disable copy constructor
  ReportEngine(const ReportEngine& a) : LogBuffer(infoDebug) {}

  static bool DoOutput;
};

// templated version of operator<< for Inform objects
template<class T>
inline ReportEngine& operator<<(ReportEngine& o, const T& val)
{
  app_debug() << val;
  return o;
}
} // namespace qmcplusplus
#endif // QMCPLUSPLUS_MPIOBJECTBASE_H