logger.cpp

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.
 */
 
#include <cstdlib>
#include <time.h>
#include "logger.h"
#include <iostream>
 
using namespace std;

Logger::Logger() {
   fileOpen = false;
   masterStream = NULL;
}

Logger::~Logger() {
   close();
   if (masterStream != NULL) {
      masterStream->close();
      delete masterStream;
   }
}

bool Logger::close() {
   if (fileOpen == false) return false;
   bool success = true;
   masterStream->close();
   delete masterStream;
   masterStream = NULL;
   fileOpen = false;
   return success;
}

bool Logger::flush(bool verbose) {
   if (fileOpen == false) return false;
   bool success = true;
   if (mpiRank != masterRank) return true;
   stringstream tmp;
   string strTime;
   if (verbose == true)
   {
      // Get the current time. Remove the line break from 
      // the string output given by ctime.
      const time_t rawTime = time(NULL);
      strTime = ctime(&rawTime);
      
      const size_t lineBreak = strTime.find('\n');
      if (lineBreak != string::npos) {
         strTime.erase(lineBreak,1);
      }
      
      // Form a new output buffer containing the process number, date 
      // and the user-given message. Attempt to write it to file.
      
      tmp << strTime << ' ' << endl;
      strTime = outStream.str();
      tmp << strTime << endl;
      
   } else {
      strTime = outStream.str();
      tmp << strTime;
   }
   (*masterStream) << tmp.str() << std::flush;
   outStream.str(string(""));
   outStream.clear();
   return success;
}

bool Logger::open(MPI_Comm comm,const int& MASTERRANK,const std::string& fname,const bool& append) {
   // Store the MPI rank of this process
   MPI_Comm_rank(comm,&mpiRank);
   masterRank = MASTERRANK;
   bool rvalue = true;
   
   if (mpiRank != MASTERRANK) return rvalue;
   masterStream = new fstream;
   if(append)
      masterStream->open(fname.c_str(), fstream::out|fstream::app);
   else
      masterStream->open(fname.c_str(), fstream::out);
 
   if (masterStream->good() == false) rvalue = false;
   fileOpen = true;
   return rvalue;
}
 
bool Logger::print(const std::string& s) {
   if (mpiRank != masterRank) return true;
   (*masterStream) << s;
   return true;
}
 
// *********************************
// ****** STREAM MANIPULATORS ******
// *********************************

Logger& Logger::operator<<(Logger& (*pf)(Logger&)) {
   if (mpiRank != masterRank) return *this;
   return (*pf)(*this);
}

Logger& Logger::operator<<(std::ostream& (*pf)(std::ostream& )) {
   if (mpiRank != masterRank) return *this;
   (*pf)(outStream);
   return *this;
}

Logger& writeVerbose(Logger& logger) {
   if (logger.flush(true) == false) {
      cerr << "Logger failed to write!" << endl;
   }
   return logger;
}

Logger& write(Logger& logger) {
   if (logger.flush(false) == false) {
      cerr << "Logger failed to write!" << endl;
   }
   return logger;
}