Manual for OpenFLUID 2.1.11

MachineListener.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 MachineListener.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
37 */
38 
39 
40 #ifndef __OPENFLUID_MACHINE_MACHINELISTENER_HPP__
41 #define __OPENFLUID_MACHINE_MACHINELISTENER_HPP__
42 
43 
44 #include <string>
45 
46 #include <openfluid/dllexport.hpp>
49 
50 
51 namespace openfluid { namespace machine {
52 
53 
55 {
56  private:
57 
58 
59  public:
60 
61  MachineListener() = default;
62 
63  virtual ~MachineListener()
64  { }
65 
66  virtual void onInitParams()
67  { }
68 
69  virtual void onInitParamsDone(const openfluid::base::Listener::Status& /*Status*/)
70  { }
71 
72  virtual void onSimulatorInitParams(const std::string& /*SimulatorID*/)
73  { }
74 
76  const std::string& /*SimulatorID*/)
77  { }
78 
79  virtual void onPrepareData()
80  { }
81 
82  virtual void onPrepareDataDone(const openfluid::base::Listener::Status& /*Status*/)
83  { }
84 
85  virtual void onSimulatorPrepareData(const std::string& /*SimulatorID*/)
86  { }
87 
89  const std::string& /*SimulatorID*/)
90  { }
91 
92  virtual void onCheckConsistency()
93  { }
94 
96  { }
97 
98  virtual void onSimulatorCheckConsistency(const std::string& /*SimulatorID*/)
99  { }
100 
102  const std::string& /*SimulatorID*/)
103  { }
104 
105  virtual void onInitializeRun()
106  { }
107 
109  { }
110 
111  virtual void onSimulatorInitializeRun(const std::string& /*SimulatorID*/)
112  { }
113 
115  const std::string& /*SimulatorID*/)
116  { }
117 
118  virtual void onBeforeRunSteps()
119  { }
120 
121  virtual void onRunStep(const openfluid::base::SimulationStatus* /*SimStatus*/)
122  { }
123 
124  virtual void onRunStepDone(const openfluid::base::Listener::Status& /*Status*/)
125  { }
126 
127  virtual void onSimulatorRunStep(const std::string& /*SimulatorID*/)
128  { }
129 
131  const std::string& /*SimulatorID*/)
132  { }
133 
134  virtual void onAfterRunSteps()
135  { }
136 
137  virtual void onFinalizeRun()
138  { }
139 
140  virtual void onFinalizeRunDone(const openfluid::base::Listener::Status& /*Status*/)
141  { }
142 
143  virtual void onSimulatorFinalizeRun(const std::string& /*SimulatorID*/)
144  { }
145 
147  const std::string& /*SimulatorID*/)
148  { }
149 
150 };
151 
152 
153 } } //namespaces
154 
155 
156 #endif /* __OPENFLUID_MACHINE_MACHINELISTENER_HPP__ */
openfluid::machine::MachineListener::onSimulatorPrepareDataDone
virtual void onSimulatorPrepareDataDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:88
OPENFLUID_API
#define OPENFLUID_API
Definition: dllexport.hpp:86
openfluid::machine::MachineListener::~MachineListener
virtual ~MachineListener()
Definition: MachineListener.hpp:63
openfluid::machine::MachineListener::onInitParamsDone
virtual void onInitParamsDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:69
openfluid::machine::MachineListener::onInitializeRun
virtual void onInitializeRun()
Definition: MachineListener.hpp:105
openfluid::machine::MachineListener::onPrepareDataDone
virtual void onPrepareDataDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:82
openfluid::machine::MachineListener::onInitializeRunDone
virtual void onInitializeRunDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:108
openfluid::base::SimulationStatus
Definition: SimulationStatus.hpp:55
openfluid::machine::MachineListener::onFinalizeRunDone
virtual void onFinalizeRunDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:140
openfluid::machine::MachineListener::onSimulatorInitParams
virtual void onSimulatorInitParams(const std::string &)
Definition: MachineListener.hpp:72
openfluid::machine::MachineListener::onSimulatorInitializeRunDone
virtual void onSimulatorInitializeRunDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:114
openfluid::machine::MachineListener::onBeforeRunSteps
virtual void onBeforeRunSteps()
Definition: MachineListener.hpp:118
openfluid::machine::MachineListener::onRunStepDone
virtual void onRunStepDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:124
openfluid::machine::MachineListener::onSimulatorFinalizeRunDone
virtual void onSimulatorFinalizeRunDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:146
openfluid::machine::MachineListener::onSimulatorInitParamsDone
virtual void onSimulatorInitParamsDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:75
openfluid::machine::MachineListener::onInitParams
virtual void onInitParams()
Definition: MachineListener.hpp:66
openfluid::machine::MachineListener::onSimulatorPrepareData
virtual void onSimulatorPrepareData(const std::string &)
Definition: MachineListener.hpp:85
openfluid::base::Listener
Definition: Listener.hpp:50
openfluid::machine::MachineListener::onRunStep
virtual void onRunStep(const openfluid::base::SimulationStatus *)
Definition: MachineListener.hpp:121
openfluid
Definition: ApplicationException.hpp:47
Listener.hpp
openfluid::machine::MachineListener::onSimulatorRunStep
virtual void onSimulatorRunStep(const std::string &)
Definition: MachineListener.hpp:127
openfluid::machine::MachineListener::onSimulatorFinalizeRun
virtual void onSimulatorFinalizeRun(const std::string &)
Definition: MachineListener.hpp:143
openfluid::machine::MachineListener::onSimulatorRunStepDone
virtual void onSimulatorRunStepDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:130
openfluid::machine::MachineListener::onCheckConsistency
virtual void onCheckConsistency()
Definition: MachineListener.hpp:92
openfluid::machine::MachineListener::onCheckConsistencyDone
virtual void onCheckConsistencyDone(const openfluid::base::Listener::Status &)
Definition: MachineListener.hpp:95
openfluid::machine::MachineListener::onPrepareData
virtual void onPrepareData()
Definition: MachineListener.hpp:79
openfluid::machine::MachineListener::onSimulatorInitializeRun
virtual void onSimulatorInitializeRun(const std::string &)
Definition: MachineListener.hpp:111
openfluid::machine::MachineListener
Definition: MachineListener.hpp:54
openfluid::machine::MachineListener::onFinalizeRun
virtual void onFinalizeRun()
Definition: MachineListener.hpp:137
SimulationStatus.hpp
openfluid::machine::MachineListener::onAfterRunSteps
virtual void onAfterRunSteps()
Definition: MachineListener.hpp:134
dllexport.hpp
openfluid::base::Listener::Status
Status
Definition: Listener.hpp:54
openfluid::machine::MachineListener::onSimulatorCheckConsistencyDone
virtual void onSimulatorCheckConsistencyDone(const openfluid::base::Listener::Status &, const std::string &)
Definition: MachineListener.hpp:101
openfluid::machine::MachineListener::onSimulatorCheckConsistency
virtual void onSimulatorCheckConsistency(const std::string &)
Definition: MachineListener.hpp:98