All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
ParameterMapItem.hpp
1 //===========================================================================
2 //
3 // File: ParameterMapItem.hpp
4 //
5 // Created: Tue Jun 2 19:05:54 2009
6 //
7 // Author(s): Bård Skaflestad <bard.skaflestad@sintef.no>
8 // Atgeirr F Rasmussen <atgeirr@sintef.no>
9 //
10 // $Date$
11 //
12 // $Revision$
13 //
14 //===========================================================================
15 
16 /*
17  Copyright 2009, 2010 SINTEF ICT, Applied Mathematics.
18  Copyright 2009, 2010 Statoil ASA.
19 
20  This file is part of the Open Porous Media project (OPM).
21 
22  OPM is free software: you can redistribute it and/or modify
23  it under the terms of the GNU General Public License as published by
24  the Free Software Foundation, either version 3 of the License, or
25  (at your option) any later version.
26 
27  OPM is distributed in the hope that it will be useful,
28  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  GNU General Public License for more details.
31 
32  You should have received a copy of the GNU General Public License
33  along with OPM. If not, see <http://www.gnu.org/licenses/>.
34 */
35 
36 #ifndef OPM_PARAMETERMAPITEM_HEADER
37 #define OPM_PARAMETERMAPITEM_HEADER
38 
39 #include <string>
40 
41 namespace Opm {
49  ParameterMapItem() : used_(false) {}
50 
52  virtual ~ParameterMapItem() {}
53 
56  virtual std::string getTag() const = 0;
57  void setUsed() const { used_ = true; }
58  bool used() const { return used_; }
59  private:
60  mutable bool used_;
61  };
62 
63  template<typename T>
65  static T convert(const ParameterMapItem&,
66  std::string& conversion_error);
67  static std::string type();
68  };
69 } // namespace Opm
70 
71 #endif // OPM_PARAMETERMAPITEM_HEADER
virtual std::string getTag() const =0
This function returns a string describing the ParameterMapItem.
Definition: ParameterMapItem.hpp:64
The parameter handlig system is structured as a tree, where each node inhertis from ParameterMapItem...
Definition: ParameterMapItem.hpp:47
virtual ~ParameterMapItem()
Destructor.
Definition: ParameterMapItem.hpp:52
ParameterMapItem()
Default constructor.
Definition: ParameterMapItem.hpp:49