Logger.h

Go to the documentation of this file.

/* 
* Copyright 2014-2018 Friedemann Zenke
*
* This file is part of Auryn, a simulation package for plastic
* spiking neural networks.
* 
* Auryn is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* Auryn is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with Auryn.  If not, see <http://www.gnu.org/licenses/>.
*
* If you are using Auryn or parts of it for your work please cite:
* Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations 
* of spiking neural networks using general-purpose computers. 
* Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
*/

#ifndef LOGGER_H_
#define LOGGER_H_

#include <iostream>
#include <iomanip>
#include <fstream>
#include <sstream>
#include <string>
#include <time.h>

#define AURYN_LOGGER_CERRLEVEL WARNING


namespace auryn {
enum LogMessageType { EVERYTHING, VERBOSE, INFO, NOTIFICATION, SETTINGS, PROGRESS, WARNING, ERROR, NONE };

class Logger
{
private:
        std::string fname;
        std::ofstream outfile;
        int local_rank;
        LogMessageType console_out;
        LogMessageType file_out;

        std::string last_message;

        
public:
        Logger(std::string filename, int rank, LogMessageType console = PROGRESS, LogMessageType file = NOTIFICATION );
        virtual ~Logger();

        void msg( std::string text, LogMessageType type=NOTIFICATION, bool global=false, int line=-1, std::string srcfile="" );
        void info    ( std::string text );
        void progress( std::string text );
        void warning ( std::string text );
        void error   ( std::string text );
        void verbose ( std::string text, bool global=false, int line=-1, std::string srcfile="" );
        void debug ( std::string text, bool global=false, int line=-1, std::string srcfile="" );
        void notification    ( std::string text );
        void set_rank(int rank);

        void set_debugging_mode();

        void set_console_loglevel(LogMessageType level = PROGRESS);

        void set_logfile_loglevel(LogMessageType level = NOTIFICATION);

        template<typename T> 
        void parameter(std::string name, T value) 
        {
                std::stringstream oss;
                oss << std::scientific << "  Parameter " << name << "=" << value;
                msg(oss.str(),SETTINGS,true);
        }
};

}

#endif /*LOGGER_H_*/