Manual for OpenFLUID 2.1.11

DistributionBindings.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 DistributionBindings.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
37  */
38 
39 
40 #ifndef __OPENFLUID_TOOLS_DISTRIBUTIONBINDINGS_HPP__
41 #define __OPENFLUID_TOOLS_DISTRIBUTIONBINDINGS_HPP__
42 
43 
44 #include <openfluid/dllexport.hpp>
47 
48 
49 namespace openfluid { namespace tools {
50 
51 
53 {
54  public:
55 
57 
59 
61 
62  ReaderNextValue(): Reader(nullptr), isAvailable(false)
63  { }
64 };
65 
66 
67 // =====================================================================
68 // =====================================================================
69 
70 
72 {
73  public:
74 
75  typedef std::map<openfluid::core::UnitID_t,ReaderNextValue*> UnitIDReader_t;
76 
77  typedef std::list<ReaderNextValue> ReadersNextValues_t;
78 
79 
80  private:
81 
82  UnitIDReader_t m_UnitIDReaders;
83 
84  ReadersNextValues_t m_ReadersNextValues;
85 
86  public:
87 
88  DistributionBindings(const DistributionTables& DistriTables);
89 
91 
92  void advanceToTime(const openfluid::core::DateTime& DT);
93 
94  bool advanceToNextTimeAfter(const openfluid::core::DateTime& DT, openfluid::core::DateTime& NextDT);
95 
96  bool getValue(const openfluid::core::UnitID_t& UnitID,
97  const openfluid::core::DateTime& DT,
99 
100  void displayBindings();
101 
102 };
103 
104 
105 } }
106 
107 
108 #endif /* __OPENFLUID_TOOLS_DISTRIBUTIONBINDINGS_HPP__ */
openfluid::tools::ReaderNextValue::Reader
ProgressiveChronFileReader * Reader
Definition: DistributionBindings.hpp:56
openfluid::tools::ChronItem_t
std::pair< openfluid::core::DateTime, double > ChronItem_t
Definition: ChronologicalSerie.hpp:53
openfluid::tools::DistributionBindings::UnitIDReader_t
std::map< openfluid::core::UnitID_t, ReaderNextValue * > UnitIDReader_t
Definition: DistributionBindings.hpp:75
OPENFLUID_API
#define OPENFLUID_API
Definition: dllexport.hpp:86
openfluid::tools::ProgressiveChronFileReader
Definition: ProgressiveChronFileReader.hpp:52
openfluid::tools::ReaderNextValue
Definition: DistributionBindings.hpp:52
openfluid::tools::ReaderNextValue::isAvailable
bool isAvailable
Definition: DistributionBindings.hpp:60
openfluid::tools::ReaderNextValue::ReaderNextValue
ReaderNextValue()
Definition: DistributionBindings.hpp:62
openfluid::tools::DistributionTables
Definition: DistributionTables.hpp:54
openfluid::core::DoubleValue
Definition: DoubleValue.hpp:80
DistributionTables.hpp
openfluid::core::UnitID_t
unsigned int UnitID_t
Definition: TypeDefs.hpp:70
openfluid::tools::DistributionBindings
Definition: DistributionBindings.hpp:71
openfluid::tools::ReaderNextValue::NextValue
ChronItem_t NextValue
Definition: DistributionBindings.hpp:58
openfluid
Definition: ApplicationException.hpp:47
openfluid::core::DateTime
Class for management of date and time information.
Definition: DateTime.hpp:87
dllexport.hpp
openfluid::tools::DistributionBindings::ReadersNextValues_t
std::list< ReaderNextValue > ReadersNextValues_t
Definition: DistributionBindings.hpp:77
ProgressiveChronFileReader.hpp