WareException.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 WareException.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
37  */
38 
39 
40 #ifndef __OPENFLUID_WARE_WAREEXCEPTION_HPP__
41 #define __OPENFLUID_WARE_WAREEXCEPTION_HPP__
42 
43 #include <sstream>
44 
49 #include <openfluid/dllexport.hpp>
50 
51 
52 namespace openfluid { namespace ware {
53 
54 
56 {
57  protected:
58 
59 
61  {
62  m_FullMessage = m_Message;
63  m_FullMessage += " [" + m_Context.toString() + "]";
64  }
65 
66 
67 
68  public:
69 
71  const std::string& Msg) :
72  openfluid::base::Exception(Context,Msg)
73  {
74  buildFullMessage();
75  }
76 
77 
78  // =====================================================================
79  // =====================================================================
80 
81 
83  const WareID_t& ID)
84  {
85 
87 
88  Context["source"] = "ware";
89  Context["waretype"] = "unknown";
90 
91  if (WType == WareType::OBSERVER)
92  Context["waretype"] = "observer";
93  else if (WType == WareType::SIMULATOR)
94  Context["waretype"] = "simulator";
95 
96  Context["wareid"] = ID;
97 
98  return Context;
99  }
100 
101 
102  // =====================================================================
103  // =====================================================================
104 
105 
107  const WareID_t& ID,
109  Stage)
110  {
111 
112  openfluid::base::ExceptionContext Context = computeContext(WType,ID);
113 
115 
116  return Context;
117  }
118 
119 
120  // =====================================================================
121  // =====================================================================
122 
123 
125  const WareID_t& ID,
127  Stage,
129  {
130  openfluid::base::ExceptionContext Context = computeContext(WType,ID,Stage);
131 
132  Context.addTimeIndex(TimeIndex);
133 
134  return Context;
135  }
136 
137 
138 
139 };
140 
141 
142 } } // namespaces
143 
144 
145 
146 
147 #endif /* __OPENFLUID_WARE_WAREEXCEPTION_HPP__ */
Definition: Exception.hpp:52
Definition: WareException.hpp:55
static openfluid::base::ExceptionContext computeContext(const WareType WType, const WareID_t &ID, const openfluid::base::SimulationStatus::SimulationStage Stage)
Definition: WareException.hpp:106
static openfluid::base::ExceptionContext computeContext(const WareType WType, const WareID_t &ID)
Definition: WareException.hpp:82
std::string WareID_t
Definition: TypeDefs.hpp:50
static std::string getStageAsString(const SimulationStage &Stage)
ExceptionContext & addStage(const std::string &StageStr)
Definition: ExceptionContext.hpp:120
static openfluid::base::ExceptionContext computeContext(const WareType WType, const WareID_t &ID, const openfluid::base::SimulationStatus::SimulationStage Stage, openfluid::core::TimeIndex_t TimeIndex)
Definition: WareException.hpp:124
Definition: ApplicationException.hpp:47
WareType
Definition: TypeDefs.hpp:62
#define OPENFLUID_API
Definition: dllexport.hpp:87
unsigned long long TimeIndex_t
Definition: DateTime.hpp:62
Definition: ExceptionContext.hpp:53
SimulationStage
Definition: SimulationStatus.hpp:59
ExceptionContext & addTimeIndex(const unsigned long long &TimeIndex)
Definition: ExceptionContext.hpp:82
WareException(const openfluid::base::ExceptionContext &Context, const std::string &Msg)
Definition: WareException.hpp:70
void buildFullMessage()
Definition: WareException.hpp:60