BCLog.h

Go to the documentation of this file.

#ifndef __BCLOG__H
#define __BCLOG__H

/*
 * Copyright (C) 2008, Daniel Kollar and Kevin Kroeninger.
 * All rights reserved.
 *
 * For the licensing terms see doc/COPYING.
 */

// ---------------------------------------------------------

#include <iostream>

// ---------------------------------------------------------

class BCLog
{
   public:

      // definition of log level

      enum LogLevel {debug, detail, summary, warning, error, nothing};

      // constructor and destructor

      BCLog();

      ~BCLog();

      // methods (get)

      static BCLog::LogLevel GetLogLevelFile()
         { return fMinimumLogLevelFile; };

      static BCLog::LogLevel GetLogLevelScreen()
         { return fMinimumLogLevelScreen; };

      // method (set)

      static void SetLogLevelFile(BCLog::LogLevel loglevel)
         { BCLog::fMinimumLogLevelFile = loglevel; };

      static void SetLogLevelScreen(BCLog::LogLevel loglevel)
         { BCLog::fMinimumLogLevelScreen = loglevel; };

      static void SetLogLevel(BCLog::LogLevel loglevel)
         { BCLog::fMinimumLogLevelFile = loglevel; BCLog::fMinimumLogLevelScreen = loglevel; };

      // methods

      static void OpenLog(const char * filename, BCLog::LogLevel loglevelfile, BCLog::LogLevel loglevelscreen);

      static void OpenLog(const char * filename);

      static void OpenLog();

      static bool IsOpen();

      static void CloseLog();

      /*
       * Writes string to the file and screen log if the log level is equal or greater than the minimum
       * @param loglevelfile loglevel for the current message
       * @param loglevelscreen loglevel for the current message
       * @param message string to write to the file and screen log */
      static void Out(BCLog::LogLevel loglevelfile, BCLog::LogLevel loglevelscreen, const char * message);

      static void Out(const char * message);

      static void Out(BCLog::LogLevel loglevel, const char * message)
         { Out(loglevel,loglevel,message); };

      static void OutError(const char * message)
         { Out(error,message); };

      static void OutWarning(const char * message)
         { Out(warning,message); };

      static void OutSummary(const char * message)
         { Out(summary,message); };

      static void OutDetail(const char * message)
         { Out(detail,message); };

      static void OutDebug(const char * message)
         { Out(debug,message); };

      static void StartupInfo();

      static const char * GetVersion()
         { return fVersion; };

      static int GetHIndex()
         { return BCLog::fHindex++; };

   private:

      static const char * fVersion;

      static BCLog::LogLevel fMinimumLogLevelFile;

      static BCLog::LogLevel fMinimumLogLevelScreen;

      static std::ofstream fOutputStream;

      static bool fFirstOutputDone;

      static const char * ToString(BCLog::LogLevel);

      static int fHindex;
};

// ---------------------------------------------------------

#endif

---