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 __SIMSTATUS_HPP__ 00057 #define __SIMSTATUS_HPP__ 00058 00059 00060 #include <openfluid/dllexport.hpp> 00061 #include <openfluid/core.hpp> 00062 00063 00064 namespace openfluid { namespace base { 00065 00066 00070 class DLLEXPORT SimulationInfo 00071 { 00072 protected: 00073 openfluid::core::DateTime m_StartTime; 00074 openfluid::core::DateTime m_EndTime; 00075 int m_TimeStep; 00076 00077 unsigned int m_StepsCount; 00078 00079 00080 00081 public: 00082 00086 SimulationInfo(openfluid::core::DateTime StartTime, 00087 openfluid::core::DateTime EndTime, 00088 int TimeStep); 00089 00093 ~SimulationInfo(); 00094 00100 inline int getTimeStep() const { return m_TimeStep; }; 00101 00107 inline unsigned int getStepsCount() const { return m_StepsCount; }; 00108 00114 inline openfluid::core::DateTime getStartTime() const { return m_StartTime; }; 00115 00121 inline openfluid::core::DateTime getEndTime() const { return m_EndTime; }; 00122 00123 00124 }; 00125 00129 class DLLEXPORT SimulationStatus : public SimulationInfo 00130 { 00131 private: 00132 00133 unsigned int m_CurrentStep; 00134 00135 openfluid::core::DateTime m_CurrentTime; 00136 00137 bool m_IsFirstStep; 00138 00139 bool m_IsLastStep; 00140 00141 public: 00145 SimulationStatus(openfluid::core::DateTime StartTime, 00146 openfluid::core::DateTime EndTime, 00147 int TimeStep); 00148 00149 00153 ~SimulationStatus(); 00154 00155 00156 bool switchToNextStep(); 00157 00163 inline unsigned int getCurrentStep() const { return m_CurrentStep; }; 00164 00170 inline openfluid::core::DateTime getCurrentTime() const { return m_CurrentTime; }; 00171 00175 inline bool isFirstStep() const { return m_IsFirstStep; }; 00176 00180 inline bool isLastStep() const { return m_IsLastStep; }; 00181 00182 00183 }; 00184 00185 00186 00187 } } // namespace openfluid::base 00188 00189 00190 #endif 00191 00192 00193 00194