MonitoringInstance.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 MonitoringInstance.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
37  */
38 
39 
40 #ifndef __OPENFLUID_MACHINE_MONITORINGINSTANCE_HPP__
41 #define __OPENFLUID_MACHINE_MONITORINGINSTANCE_HPP__
42 
43 #include <openfluid/dllexport.hpp>
46 
47 #include <list>
48 
49 
50 namespace openfluid { namespace machine {
51 
52 
53 class SimulationBlob;
54 class ObserverInstance;
55 
56 
58 {
59  private:
60 
61  std::list<ObserverInstance*> m_Observers;
62 
63  openfluid::machine::SimulationBlob& m_SimulationBlob;
64 
65  bool m_Initialized;
66 
67  public:
68 
70 
72 
73  void appendObserver(ObserverInstance* ObsInstance);
74 
75  const std::list<ObserverInstance*>& observers() const { return m_Observers; };
76 
77  void initialize(openfluid::base::SimulationLogger* mp_SimLogger);
78 
79  void finalize();
80 
81  void call_initParams() const;
82 
83  void call_onPrepared() const;
84 
85  void call_onInitializedRun() const;
86 
87  void call_onStepCompleted(const openfluid::core::TimeIndex_t& TimeIndex) const;
88 
89  void call_onFinalizedRun() const;
90 };
91 
92 
93 } } // namespaces
94 
95 
96 #endif /* __OPENFLUID_MACHINE_MONITORINGINSTANCE_HPP__ */
Definition: ObserverInstance.hpp:71
Definition: SimulationLogger.hpp:59
Definition: MonitoringInstance.hpp:57
Definition: SimulationBlob.hpp:52
const std::list< ObserverInstance * > & observers() const
Definition: MonitoringInstance.hpp:75
Definition: ApplicationException.hpp:47
#define OPENFLUID_API
Definition: dllexport.hpp:87
unsigned long long TimeIndex_t
Definition: DateTime.hpp:62