SimulationLogger.hpp
Go to the documentation of this file.
1 /*
2 
3  This file is part of OpenFLUID software
4  Copyright(c) 2007, INRA - Montpellier SupAgro
5 
6 
7  == GNU General Public License Usage ==
8 
9  OpenFLUID is free software: you can redistribute it and/or modify
10  it under the terms of the GNU General Public License as published by
11  the Free Software Foundation, either version 3 of the License, or
12  (at your option) any later version.
13 
14  OpenFLUID is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
21 
22 
23  == Other Usage ==
24 
25  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
26  license, and requires a written agreement between You and INRA.
27  Licensees for Other Usage of OpenFLUID may use this file in accordance
28  with the terms contained in the written agreement between You and INRA.
29 
30 */
31 
32 
33 
34 /**
35  @file SimulationLogger.hpp
36 
37  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
38 */
39 
40 
41 #ifndef __OPENFLUID_BASE_SIMULATIONLOGGER_HPP__
42 #define __OPENFLUID_BASE_SIMULATIONLOGGER_HPP__
43 
44 
45 #include <openfluid/dllexport.hpp>
46 #include <openfluid/core/TypeDefs.hpp>
49 #include <openfluid/ware/TypeDefs.hpp>
52 
54 
55 
56 namespace openfluid { namespace base {
57 
58 
60 {
61 
62  private:
63 
64  bool m_CurrentWarningFlag;
65 
66 
67  public:
68 
69  SimulationLogger(const std::string& LogFilePath);
70 
71 
73 
74 
75  void add(LogType LType, const std::string& ContextStr, const std::string& Msg);
76 
77  void addInfo(const std::string& Context, const std::string& Msg)
78  { add(LOG_INFO,Context,Msg); }
79 
80  void addDebug(const std::string& Context, const std::string& Msg)
81  { add(LOG_DEBUG,Context,Msg); }
82 
83  void addWarning(const std::string& Context, const std::string& Msg)
84  { add(LOG_WARNING,Context,Msg); }
85 
86  void addError(const std::string& Context, const std::string& Msg)
87  { add(LOG_ERROR,Context,Msg); }
88 
89 
90  inline void resetCurrentWarningFlag() { m_CurrentWarningFlag = false; };
91 
92  inline bool isCurrentWarningFlag() const { return m_CurrentWarningFlag; };
93 
94 };
95 
96 
97 } } // namespaces
98 
99 
100 #endif /*__OPENFLUID_BASE_SIMULATIONLOGGER_HPP__*/
101 
void addDebug(const std::string &Context, const std::string &Msg)
Definition: SimulationLogger.hpp:80
Definition: SimulationLogger.hpp:59
void addInfo(const std::string &Context, const std::string &Msg)
Definition: SimulationLogger.hpp:77
Definition: FileLogger.hpp:52
void addError(const std::string &Context, const std::string &Msg)
Definition: SimulationLogger.hpp:86
Definition: ApplicationException.hpp:47
bool isCurrentWarningFlag() const
Definition: SimulationLogger.hpp:92
void resetCurrentWarningFlag()
Definition: SimulationLogger.hpp:90
#define OPENFLUID_API
Definition: dllexport.hpp:87
void addWarning(const std::string &Context, const std::string &Msg)
Definition: SimulationLogger.hpp:83
LogType
Definition: FileLogger.hpp:69