Documentation for OpenFLUID 2.2.0
Exception.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  @file Exception.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
37 */
38 
39 
40 #ifndef __OPENFLUID_BASE_EXCEPTION_HPP__
41 #define __OPENFLUID_BASE_EXCEPTION_HPP__
42 
43 
44 #include <exception>
45 
47 
48 
49 namespace openfluid { namespace base {
50 
51 
52 class Exception : public std::exception
53 {
54  protected:
55 
56  std::string m_Message;
57 
59 
60  std::string m_FullMessage;
61 
62 
63  virtual void buildFullMessage() = 0;
64 
65 
66  Exception(const std::string& Msg) :
67  m_Message(Msg), m_FullMessage("")
68  { }
69 
70  Exception(const ExceptionContext& Context, const std::string& Msg) :
71  m_Message(Msg), m_Context(Context), m_FullMessage("")
72  { }
73 
74 
75  public:
76 
77  Exception() = delete;
78 
79  virtual ~Exception() throw()
80  { }
81 
82 
83  // =====================================================================
84  // =====================================================================
85 
86 
87  const char * what() const throw()
88  {
89 #ifdef NDEBUG
90  return m_Message.c_str();
91 #else
92  return m_FullMessage.c_str();
93 #endif
94  }
95 
96 
97  // =====================================================================
98  // =====================================================================
99 
100 
101  const std::string getMessage() const
102  {
103  return m_Message;
104  }
105 
106 
107  // =====================================================================
108  // =====================================================================
109 
110 
111  const std::string getFullMessage() const
112  {
113  return m_FullMessage;
114  }
115 
116 
117  // =====================================================================
118  // =====================================================================
119 
120 
122  {
123  return m_Context;
124  }
125 
126 };
127 
128 
129 } } // namespace
130 
131 #endif /* __OPENFLUID_BASE_EXCEPTION_HPP__ */
Definition: ExceptionContext.hpp:54
Definition: Exception.hpp:53
virtual ~Exception()
Definition: Exception.hpp:79
const std::string getMessage() const
Definition: Exception.hpp:101
const char * what() const
Definition: Exception.hpp:87
virtual void buildFullMessage()=0
const std::string getFullMessage() const
Definition: Exception.hpp:111
std::string m_Message
Definition: Exception.hpp:56
Exception(const std::string &Msg)
Definition: Exception.hpp:66
std::string m_FullMessage
Definition: Exception.hpp:60
const ExceptionContext getContext() const
Definition: Exception.hpp:121
ExceptionContext m_Context
Definition: Exception.hpp:58
Exception(const ExceptionContext &Context, const std::string &Msg)
Definition: Exception.hpp:70
Definition: ApplicationException.hpp:47