Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MetaInfoInterface.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_METAINFOINTERFACE_H
36 #define OPENMS_METADATA_METAINFOINTERFACE_H
37 
38 #include <map>
39 #include <string>
40 
41 #include <iostream>
42 
44 
45 namespace OpenMS
46 {
47  class String;
48 
61  class OPENMS_DLLAPI MetaInfoInterface
62  {
63 public:
64 
71 
73  MetaInfoInterface & operator=(const MetaInfoInterface & rhs);
74 
76  bool operator==(const MetaInfoInterface & rhs) const;
78  bool operator!=(const MetaInfoInterface & rhs) const;
79 
81  const DataValue & getMetaValue(const String & name) const;
83  const DataValue & getMetaValue(UInt index) const;
84 
86  bool metaValueExists(const String & name) const;
88  bool metaValueExists(UInt index) const;
89 
91  void setMetaValue(const String & name, const DataValue & value);
93  void setMetaValue(UInt index, const DataValue & value);
94 
96  void removeMetaValue(const String & name);
98  void removeMetaValue(UInt index);
99 
101  static MetaInfoRegistry & metaRegistry();
102 
104  void getKeys(std::vector<String> & keys) const;
105 
107  void getKeys(std::vector<UInt> & keys) const;
108 
110  bool isMetaEmpty() const;
111 
113  void clearMetaInfo();
114 
115 protected:
117  inline void createIfNotExists_();
120  };
121 
122 } // namespace OpenMS
123 
124 #endif // OPENMS_METADATA_METAINFOINTERFACE_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
MetaInfo * meta_
pointer to the MetaInfo object. 0 by default
Definition: MetaInfoInterface.h:119
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
Registry which assigns unique integer indices to strings.
Definition: MetaInfoRegistry.h:74
A Type-Name-Value tuple class.
Definition: MetaInfo.h:67

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