Documentation for OpenFLUID 2.2.0
AttributesTableDescriptor.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 AttributesTableDescriptor.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
37  */
38 
39 
40 #ifndef __OPENFLUID_FLUIDX_ATTRIBUTESTABLEDESCRIPTOR_HPP__
41 #define __OPENFLUID_FLUIDX_ATTRIBUTESTABLEDESCRIPTOR_HPP__
42 
43 
44 #include <openfluid/dllexport.hpp>
45 #include <openfluid/core/TypeDefs.hpp>
46 
47 
48 namespace openfluid { namespace fluidx {
49 
50 
52 {
53  public:
54  typedef std::map<openfluid::core::AttributeName_t,std::string> AttributeNameValue_t;
55 
56  typedef std::map<openfluid::core::UnitID_t,AttributeNameValue_t> UnitIDAttribute_t;
57 
58 
59  private:
60 
61  openfluid::core::UnitsClass_t m_UnitsClass;
62 
63  std::vector<std::string> m_ColumnsOrder;
64 
65  UnitIDAttribute_t m_Data;
66 
67 
68  public:
69 
71 
73 
74  void parseDataBlob(const std::string& Data);
75 
77  {
78  return m_UnitsClass;
79  };
80 
81  inline void setUnitsClass(const openfluid::core::UnitsClass_t& UClass)
82  {
83  m_UnitsClass = UClass;
84  };
85 
86  inline const std::vector<std::string>& columnsOrder() const
87  {
88  return m_ColumnsOrder;
89  };
90 
91  inline void setColumnsOrder(const std::vector<std::string>& Cols)
92  {
93  m_ColumnsOrder = Cols;
94  };
95 
96  inline const UnitIDAttribute_t& attributes() const
97  {
98  return m_Data;
99  };
100 
102  {
103  return m_Data;
104  };
105 
106 };
107 
108 
109 } } // namespaces
110 
111 
112 #endif /* __OPENFLUID_FLUIDX_ATTRIBUTESTABLEDESCRIPTOR_HPP__ */
Definition: AttributesTableDescriptor.hpp:52
std::map< openfluid::core::AttributeName_t, std::string > AttributeNameValue_t
Definition: AttributesTableDescriptor.hpp:54
const openfluid::core::UnitsClass_t getUnitsClass() const
Definition: AttributesTableDescriptor.hpp:76
UnitIDAttribute_t & attributes()
Definition: AttributesTableDescriptor.hpp:101
std::map< openfluid::core::UnitID_t, AttributeNameValue_t > UnitIDAttribute_t
Definition: AttributesTableDescriptor.hpp:56
const std::vector< std::string > & columnsOrder() const
Definition: AttributesTableDescriptor.hpp:86
void setUnitsClass(const openfluid::core::UnitsClass_t &UClass)
Definition: AttributesTableDescriptor.hpp:81
void setColumnsOrder(const std::vector< std::string > &Cols)
Definition: AttributesTableDescriptor.hpp:91
void parseDataBlob(const std::string &Data)
const UnitIDAttribute_t & attributes() const
Definition: AttributesTableDescriptor.hpp:96
#define OPENFLUID_API
Definition: dllexport.hpp:86
std::string UnitsClass_t
Definition: TypeDefs.hpp:98
Definition: ApplicationException.hpp:47