Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MetaInfo.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Andreas Bertsch $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_METAINFO_H
36 #define OPENMS_METADATA_METAINFO_H
37 
38 #include <map>
39 #include <string>
40 #include <vector>
41 
42 #include <OpenMS/CONCEPT/Types.h>
45 
46 namespace OpenMS
47 {
48  class String;
49 
67  class OPENMS_DLLAPI MetaInfo
68  {
69 public:
71  MetaInfo();
72 
74  MetaInfo(const MetaInfo & rhs);
75 
77  ~MetaInfo();
78 
80  MetaInfo & operator=(const MetaInfo & rhs);
81 
83  bool operator==(const MetaInfo & rhs) const;
85  bool operator!=(const MetaInfo & rhs) const;
86 
88  const DataValue & getValue(const String & name) const;
90  const DataValue & getValue(UInt index) const;
91 
93  bool exists(const String & name) const;
95  bool exists(UInt index) const;
96 
98  void setValue(const String & name, const DataValue & value);
100  void setValue(UInt index, const DataValue & value);
101 
103  void removeValue(const String & name);
105  void removeValue(UInt index);
106 
108  static MetaInfoRegistry & registry();
109 
111  void getKeys(std::vector<String> & keys) const;
112 
114  void getKeys(std::vector<UInt> & keys) const;
115 
117  bool empty() const;
118 
120  void clear();
121 
122 private:
126  std::map<UInt, DataValue> index_to_value_;
127 
128  };
129 
130 } // namespace OpenMS
131 
132 #endif // OPENMS_METADATA_METAINFO_H
A more convenient string class.
Definition: String.h:56
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:57
static MetaInfoRegistry registry_
static MetaInfoRegistry
Definition: MetaInfo.h:124
Registry which assigns unique integer indices to strings.
Definition: MetaInfoRegistry.h:74
A Type-Name-Value tuple class.
Definition: MetaInfo.h:67
std::map< UInt, DataValue > index_to_value_
the actual mapping of index to the DataValue
Definition: MetaInfo.h:126

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:17 using doxygen 1.8.5