RunDescriptor.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 /**
35  @file RunDescriptor.hpp
36 
37  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
38  */
39 
40 
41 #ifndef __OPENFLUID_FLUIDX_RUNDESCRIPTOR_HPP__
42 #define __OPENFLUID_FLUIDX_RUNDESCRIPTOR_HPP__
43 
44 #include <openfluid/dllexport.hpp>
47 
48 
49 namespace openfluid { namespace fluidx {
50 
52 {
53  private:
54 
55  int m_DeltaT;
56 
58 
59  openfluid::core::DateTime m_BeginDate;
60  openfluid::core::DateTime m_EndDate;
61 
62  bool m_IsUserValuesBufferSize;
63  unsigned int m_ValuesBufferSize;
64 
65  bool m_Filled;
66 
67  public:
68 
69  RunDescriptor();
70 
71  RunDescriptor(int DeltaT,
73 
74  ~RunDescriptor();
75 
77  {return m_BeginDate; };
78 
79  inline void setBeginDate(const openfluid::core::DateTime BeginDate)
80  { m_BeginDate = BeginDate; };
81 
83  {return m_EndDate; };
84 
85  inline void setEndDate(const openfluid::core::DateTime EndDate)
86  { m_EndDate = EndDate; };
87 
88  inline int getDeltaT() const
89  {return m_DeltaT; };
90 
91  inline void setDeltaT(const int DeltaT)
92  { m_DeltaT = DeltaT; };
93 
94  inline void setValuesBufferSize(const unsigned int StepsNbr)
95  {
96  m_ValuesBufferSize = StepsNbr; m_IsUserValuesBufferSize = true;
97  };
98 
99  inline bool isUserValuesBufferSize() const
100  { return m_IsUserValuesBufferSize; };
101 
102  inline unsigned int getValuesBufferSize() const
103  { return m_ValuesBufferSize; };
104 
106  { return m_SchedConstraint; };
107 
109  { m_SchedConstraint = SConst; };
110 
111  inline bool isFilled() const
112  { return m_Filled; };
113 
114  inline void setFilled(const bool Filled)
115  { m_Filled = Filled; };
116 
118  {
119  m_IsUserValuesBufferSize = false;
120  }
121 
122 };
123 
124 } } // namespaces
125 
126 
127 #endif /* __OPENFLUID_FLUIDX_RUNDESCRIPTOR_HPP__ */
openfluid::core::DateTime getBeginDate() const
Definition: RunDescriptor.hpp:76
openfluid::base::SimulationStatus::SchedulingConstraint getSchedulingConstraint() const
Definition: RunDescriptor.hpp:105
void setSchedulingConstraint(const openfluid::base::SimulationStatus::SchedulingConstraint &SConst)
Definition: RunDescriptor.hpp:108
void setDeltaT(const int DeltaT)
Definition: RunDescriptor.hpp:91
int getDeltaT() const
Definition: RunDescriptor.hpp:88
bool isUserValuesBufferSize() const
Definition: RunDescriptor.hpp:99
void unsetUserValuesBufferSize()
Definition: RunDescriptor.hpp:117
void setFilled(const bool Filled)
Definition: RunDescriptor.hpp:114
void setBeginDate(const openfluid::core::DateTime BeginDate)
Definition: RunDescriptor.hpp:79
Definition: RunDescriptor.hpp:51
openfluid::core::DateTime getEndDate() const
Definition: RunDescriptor.hpp:82
SchedulingConstraint
Definition: SimulationStatus.hpp:62
unsigned int getValuesBufferSize() const
Definition: RunDescriptor.hpp:102
Definition: ApplicationException.hpp:47
#define OPENFLUID_API
Definition: dllexport.hpp:87
bool isFilled() const
Definition: RunDescriptor.hpp:111
void setEndDate(const openfluid::core::DateTime EndDate)
Definition: RunDescriptor.hpp:85
Class for management of date and time information.
Definition: DateTime.hpp:132
void setValuesBufferSize(const unsigned int StepsNbr)
Definition: RunDescriptor.hpp:94