Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
LogFile.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef LOGFILE_HPP_
37#define LOGFILE_HPP_
38
39#include <string>
40#include "OutputFileHandler.hpp"
41#include <iostream>
42#include <cassert>
43#include <iomanip>
44#include <ctime>
45
81{
82private:
83
86
89
91 out_stream mpOutStream;
92
94 time_t mInitTime;
95
97 unsigned mLevel;
98
100 static const unsigned mMaxLoggingLevel = 2;
101
103 unsigned mPrecision;
104
108 LogFile();
109
110public:
111
115 static LogFile* Instance();
116
120 static unsigned Level();
121
138 void Set(unsigned level, const std::string& rDirectory, const std::string& rFileName="log.txt");
139
143 static unsigned MaxLoggingLevel();
144
151 void SetPrecision(unsigned precision);
152
160 void WriteHeader(std::string simulationType="");
161
167 void WriteElapsedTime(std::string pre="");
168
172 static void Close();
173
177 bool IsFileSet();
178
186 template <class T>
187 LogFile& operator<<(T message)
188 {
189 if (mFileSet)
190 {
191 (*mpOutStream) << std::setprecision((int)mPrecision) << message << std::flush;
192 }
193
194 return *this;
195 }
196};
197
198// Define the log macro
199#define LOG(level, message) assert(level>0); if(level <= LogFile::Level()) { (*LogFile::Instance()) << message << "\n"; }
200#define LOG_AND_COUT(level, message) {std::cout << message << std::endl << std::flush; LOG(level, message); }
201
202#endif /*LOGFILE_HPP_*/
void SetPrecision(unsigned precision)
Definition LogFile.cpp:134
static LogFile * mpInstance
Definition LogFile.hpp:85
unsigned mLevel
Definition LogFile.hpp:97
out_stream mpOutStream
Definition LogFile.hpp:91
void Set(unsigned level, const std::string &rDirectory, const std::string &rFileName="log.txt")
Definition LogFile.cpp:73
static LogFile * Instance()
Definition LogFile.cpp:52
LogFile & operator<<(T message)
Definition LogFile.hpp:187
time_t mInitTime
Definition LogFile.hpp:94
void WriteElapsedTime(std::string pre="")
Definition LogFile.cpp:116
void WriteHeader(std::string simulationType="")
Definition LogFile.cpp:111
unsigned mPrecision
Definition LogFile.hpp:103
static const unsigned mMaxLoggingLevel
Definition LogFile.hpp:100
bool IsFileSet()
Definition LogFile.cpp:129
static unsigned MaxLoggingLevel()
Definition LogFile.cpp:96
static void Close()
Definition LogFile.cpp:101
bool mFileSet
Definition LogFile.hpp:88
LogFile()
Definition LogFile.cpp:44
static unsigned Level()
Definition LogFile.cpp:61