logger.h

Go to the documentation of this file.

/*
 * This file is part of Vlasiator.
 * Copyright 2010-2016 Finnish Meteorological Institute
 *
 * For details of usage, see the COPYING file and read the "Rules of the Road"
 * at http://www.physics.helsinki.fi/vlasiator/
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef LOGGER_H
#define LOGGER_H
 
#include <fstream>
#include <sstream>
#include <mpi.h>

class Logger {
public:
   Logger();
   ~Logger();
   
   void clear() {outStream.clear();}
   bool close();
   bool flush(bool verbose);
   std::stringstream& getStream() {return outStream;}
   bool open(MPI_Comm comm,const int& MASTERRANK,const std::string& fname,const bool& append=false);
   bool print(const std::string& s);
   std::string str() {return outStream.str();}
   
   // ****************************************
   // ****** STREAM INSERTION OPERATORS ******
   // ****************************************
   
   template<typename T> inline Logger& operator<<(const T& value);
   Logger& operator<<(Logger& (*pf)(Logger&));
   Logger& operator<<(std::ostream& (*pf)(std::ostream& ));
   
private:
   bool fileOpen;                       
   int mpiRank;                         
   int masterRank;                      
   std::stringstream outStream;         
   std::fstream* masterStream;          
};

template<typename T>
Logger& Logger::operator<<(const T& value) {
   outStream << value;
   return *this;
}
 
Logger& writeVerbose(Logger& logger);
Logger& write(Logger& logger);
 
#endif