00001 /* 00002 00003 This file is part of OpenFLUID software 00004 Copyright(c) 2007, INRA - Montpellier SupAgro 00005 00006 00007 == GNU General Public License Usage == 00008 00009 OpenFLUID is free software: you can redistribute it and/or modify 00010 it under the terms of the GNU General Public License as published by 00011 the Free Software Foundation, either version 3 of the License, or 00012 (at your option) any later version. 00013 00014 OpenFLUID is distributed in the hope that it will be useful, 00015 but WITHOUT ANY WARRANTY; without even the implied warranty of 00016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00017 GNU General Public License for more details. 00018 00019 You should have received a copy of the GNU General Public License 00020 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00021 00022 00023 == Other Usage == 00024 00025 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00026 license, and requires a written agreement between You and INRA. 00027 Licensees for Other Usage of OpenFLUID may use this file in accordance 00028 with the terms contained in the written agreement between You and INRA. 00029 00030 */ 00031 00032 00033 00034 /** 00035 @file 00036 00037 @author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00038 */ 00039 00040 00041 #ifndef __RUNDESCRIPTOR_HPP__ 00042 #define __RUNDESCRIPTOR_HPP__ 00043 00044 #include <openfluid/dllexport.hpp> 00045 #include <openfluid/core/DateTime.hpp> 00046 #include <openfluid/base/SimulationStatus.hpp> 00047 00048 00049 namespace openfluid { namespace fluidx { 00050 00051 class DLLEXPORT RunDescriptor 00052 { 00053 private: 00054 00055 int m_DeltaT; 00056 00057 openfluid::base::SimulationStatus::SchedulingConstraint m_SchedConstraint; 00058 00059 openfluid::core::DateTime m_BeginDate; 00060 openfluid::core::DateTime m_EndDate; 00061 00062 bool m_IsUserValuesBufferSize; 00063 unsigned int m_ValuesBufferSize; 00064 00065 bool m_Filled; 00066 00067 public: 00068 00069 RunDescriptor(); 00070 00071 RunDescriptor(int DeltaT, 00072 openfluid::core::DateTime BeginDate,openfluid::core::DateTime EndDate); 00073 00074 ~RunDescriptor(); 00075 00076 inline openfluid::core::DateTime getBeginDate() const {return m_BeginDate; }; 00077 00078 inline void setBeginDate(const openfluid::core::DateTime BeginDate) { m_BeginDate = BeginDate; }; 00079 00080 inline openfluid::core::DateTime getEndDate() const {return m_EndDate; }; 00081 00082 inline void setEndDate(const openfluid::core::DateTime EndDate) { m_EndDate = EndDate; }; 00083 00084 inline int getDeltaT() const {return m_DeltaT; }; 00085 00086 inline void setDeltaT(const int DeltaT) { m_DeltaT = DeltaT; }; 00087 00088 inline void setValuesBufferSize(const unsigned int StepsNbr) 00089 { 00090 m_ValuesBufferSize = StepsNbr; m_IsUserValuesBufferSize = true; 00091 }; 00092 00093 inline bool isUserValuesBufferSize() const { return m_IsUserValuesBufferSize; }; 00094 00095 inline unsigned int getValuesBufferSize() const { return m_ValuesBufferSize; }; 00096 00097 inline openfluid::base::SimulationStatus::SchedulingConstraint getSchedulingConstraint() const { return m_SchedConstraint; }; 00098 00099 inline void setSchedulingConstraint(const openfluid::base::SimulationStatus::SchedulingConstraint& SConst) { m_SchedConstraint = SConst; }; 00100 00101 inline bool isFilled() const { return m_Filled; }; 00102 00103 inline void setFilled(const bool Filled) { m_Filled = Filled; }; 00104 00105 inline void unsetUserValuesBufferSize() 00106 { 00107 m_IsUserValuesBufferSize = false; 00108 } 00109 00110 }; 00111 00112 } } // namespaces 00113 00114 00115 #endif /* __RUNDESCRIPTOR_HPP__ */