Chaste  Release::3.4
LogFile.cpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "LogFile.hpp"
37 #include "Exception.hpp"
38 
39 #include <cmath>
40 #include <sstream>
41 
43 
45  : mFileSet(false),
46  mInitTime(time(NULL)),
47  mLevel(0),
48  mPrecision(6)
49 {
50 }
51 
53 {
54  if (mpInstance == NULL)
55  {
56  mpInstance = new LogFile; // default construtor which doesn't write
57  }
58  return mpInstance;
59 }
60 
61 unsigned LogFile::Level()
62 {
63  if (mpInstance == NULL)
64  {
65  return 0;
66  }
67  else
68  {
69  return mpInstance->mLevel;
70  }
71 }
72 
73 void LogFile::Set(unsigned level, const std::string& rDirectory, const std::string& rFileName)
74 {
75  if (level > mMaxLoggingLevel)
76  {
77  EXCEPTION("Requested level " << level
78  << " should have been less than or equal to "
79  << mMaxLoggingLevel);
80  }
81  mLevel = level;
82 
85 // std::string file = "/home/chaste/Desktop/" + fileName;
86 // out_stream p_file(new std::ofstream(file.c_str()));
87 // mpOutStream = p_file;
88 
89  OutputFileHandler handler(rDirectory, false);
90  mpOutStream = handler.OpenOutputFile(rFileName);
91  mFileSet = true;
92 
93  // Write header in the log file..?
94 }
95 
97 {
98  return mMaxLoggingLevel;
99 }
100 
102 {
103  if (mpInstance)
104  {
105  mpInstance->mpOutStream->close();
106  delete mpInstance;
107  mpInstance = NULL;
108  }
109 }
110 
111 void LogFile::WriteHeader(std::string simulationType)
112 {
113  *this << "\nChaste: " << simulationType << " simulation, on " << ctime(&mInitTime) << "\n";
114 }
115 
116 void LogFile::WriteElapsedTime(std::string pre)
117 {
118  double fsecs = difftime(time(NULL),mInitTime);
119  long total_secs = static_cast<long>(floor(fsecs+0.5));
120  int total_mins = total_secs/60;
121 
122  int secs = total_secs%60;
123  int mins = total_mins%60;
124  int hrs = total_mins/60;
125 
126  *this << pre << "Elapsed time is: " << hrs << "h " << mins << "m " << secs << "s\n";
127 }
128 
130 {
131  return mFileSet;
132 }
133 
134 void LogFile::SetPrecision(unsigned precision)
135 {
136  assert(precision > 0);
137  mPrecision = precision;
138 }
void Set(unsigned level, const std::string &rDirectory, const std::string &rFileName="log.txt")
Definition: LogFile.cpp:73
#define EXCEPTION(message)
Definition: Exception.hpp:143
bool mFileSet
Definition: LogFile.hpp:88
out_stream mpOutStream
Definition: LogFile.hpp:91
static const unsigned mMaxLoggingLevel
Definition: LogFile.hpp:100
out_stream OpenOutputFile(const std::string &rFileName, std::ios_base::openmode mode=std::ios::out|std::ios::trunc) const
static void Close()
Definition: LogFile.cpp:101
static LogFile * mpInstance
Definition: LogFile.hpp:85
static unsigned Level()
Definition: LogFile.cpp:61
void SetPrecision(unsigned precision)
Definition: LogFile.cpp:134
void WriteHeader(std::string simulationType="")
Definition: LogFile.cpp:111
LogFile()
Definition: LogFile.cpp:44
unsigned mLevel
Definition: LogFile.hpp:97
void WriteElapsedTime(std::string pre="")
Definition: LogFile.cpp:116
static LogFile * Instance()
Definition: LogFile.cpp:52
time_t mInitTime
Definition: LogFile.hpp:94
bool IsFileSet()
Definition: LogFile.cpp:129
static unsigned MaxLoggingLevel()
Definition: LogFile.cpp:96
unsigned mPrecision
Definition: LogFile.hpp:103