00001 /* 00002 This file is part of OpenFLUID software 00003 Copyright (c) 2007-2010 INRA-Montpellier SupAgro 00004 00005 00006 == GNU General Public License Usage == 00007 00008 OpenFLUID is free software: you can redistribute it and/or modify 00009 it under the terms of the GNU General Public License as published by 00010 the Free Software Foundation, either version 3 of the License, or 00011 (at your option) any later version. 00012 00013 OpenFLUID is distributed in the hope that it will be useful, 00014 but WITHOUT ANY WARRANTY; without even the implied warranty of 00015 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 GNU General Public License for more details. 00017 00018 You should have received a copy of the GNU General Public License 00019 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00020 00021 In addition, as a special exception, INRA gives You the additional right 00022 to dynamically link the code of OpenFLUID with code not covered 00023 under the GNU General Public License ("Non-GPL Code") and to distribute 00024 linked combinations including the two, subject to the limitations in this 00025 paragraph. Non-GPL Code permitted under this exception must only link to 00026 the code of OpenFLUID dynamically through the OpenFLUID libraries 00027 interfaces, and only for building OpenFLUID plugins. The files of 00028 Non-GPL Code may be link to the OpenFLUID libraries without causing the 00029 resulting work to be covered by the GNU General Public License. You must 00030 obey the GNU General Public License in all respects for all of the 00031 OpenFLUID code and other code used in conjunction with OpenFLUID 00032 except the Non-GPL Code covered by this exception. If you modify 00033 this OpenFLUID, you may extend this exception to your version of the file, 00034 but you are not obligated to do so. If you do not wish to provide this 00035 exception without modification, you must delete this exception statement 00036 from your version and license this OpenFLUID solely under the GPL without 00037 exception. 00038 00039 00040 == Other Usage == 00041 00042 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00043 license, and requires a written agreement between You and INRA. 00044 Licensees for Other Usage of OpenFLUID may use this file in accordance 00045 with the terms contained in the written agreement between You and INRA. 00046 */ 00047 00048 00056 #ifndef __MACHINELISTENER_HPP__ 00057 #define __MACHINELISTENER_HPP__ 00058 00059 #include <openfluid/dllexport.hpp> 00060 #include <openfluid/base/Listener.hpp> 00061 #include <openfluid/base/SimStatus.hpp> 00062 #include <string> 00063 00064 namespace openfluid { namespace machine { 00065 00066 // ===================================================================== 00067 // ===================================================================== 00068 00069 00070 class DLLEXPORT MachineListener : public openfluid::base::Listener 00071 { 00072 private: 00073 00074 00075 public: 00076 00077 MachineListener() {}; 00078 00079 virtual ~MachineListener() {}; 00080 00081 virtual void onInitParams() {}; 00082 00083 virtual void onInitParamsDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00084 00085 virtual void onFunctionInitParams(const std::string& /*FunctionID*/) {}; 00086 00087 virtual void onFunctionInitParamsDone(const openfluid::base::Listener::Status& /*Status*/, 00088 const std::string& /*FunctionID*/) {}; 00089 00090 virtual void onPrepareData() {}; 00091 00092 virtual void onPrepareDataDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00093 00094 virtual void onFunctionPrepareData(const std::string& /*FunctionID*/) {}; 00095 00096 virtual void onFunctionPrepareDataDone(const openfluid::base::Listener::Status& /*Status*/, 00097 const std::string& /*FunctionID*/) {}; 00098 00099 virtual void onCheckConsistency() {}; 00100 00101 virtual void onCheckConsistencyDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00102 00103 virtual void onFunctionCheckConsistency(const std::string& /*FunctionID*/) {}; 00104 00105 virtual void onFunctionCheckConsistencyDone(const openfluid::base::Listener::Status& /*Status*/, 00106 const std::string& /*FunctionID*/) {}; 00107 00108 virtual void onInitializeRun() {}; 00109 00110 virtual void onInitializeRunDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00111 00112 virtual void onFunctionInitializeRun(const std::string& /*FunctionID*/) {}; 00113 00114 virtual void onFunctionInitializeRunDone(const openfluid::base::Listener::Status& /*Status*/, 00115 const std::string& /*FunctionID*/) {}; 00116 00117 virtual void onBeforeRunSteps() {}; 00118 00119 virtual void onRunStep(const openfluid::base::SimulationStatus* /*SimStatus*/) {}; 00120 00121 virtual void onRunStepDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00122 00123 virtual void onFunctionRunStep(const std::string& /*FunctionID*/) {}; 00124 00125 virtual void onFunctionRunStepDone(const openfluid::base::Listener::Status& /*Status*/, 00126 const std::string& /*FunctionID*/) {}; 00127 00128 virtual void onAfterRunSteps() {}; 00129 00130 virtual void onFinalizeRun() {}; 00131 00132 virtual void onFinalizeRunDone(const openfluid::base::Listener::Status& /*Status*/) {}; 00133 00134 virtual void onFunctionFinalizeRun(const std::string& /*FunctionID*/) {}; 00135 00136 virtual void onFunctionFinalizeRunDone(const openfluid::base::Listener::Status& /*Status*/, 00137 const std::string& /*FunctionID*/) {}; 00138 00139 }; 00140 00141 00142 } } //namespaces 00143 00144 #endif /* __MACHINELISTENER_HPP__ */