| OpenMS 2.5.0

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-2020.
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: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <vector>
38
39 #include <OpenMS/CONCEPT/Types.h>
40 #include <OpenMS/METADATA/MetaInfoRegistry.h>
41 #include <OpenMS/DATASTRUCTURES/DataValue.h>
42
43 namespace OpenMS
44 {
45 class String;
46 class MetaInfo;
47
60 class OPENMS_DLLAPI MetaInfoInterface
61 {
62 public:
63
65 MetaInfoInterface();
67 MetaInfoInterface(const MetaInfoInterface& rhs);
69 MetaInfoInterface(MetaInfoInterface&&) noexcept;
71 ~MetaInfoInterface();
72
74 MetaInfoInterface& operator=(const MetaInfoInterface& rhs);
76 MetaInfoInterface& operator=(MetaInfoInterface&&) noexcept;
77
79 bool operator==(const MetaInfoInterface& rhs) const;
81 bool operator!=(const MetaInfoInterface& rhs) const;
82
84 const DataValue& getMetaValue(const String& name, const DataValue& default_value = DataValue::EMPTY) const;
86 const DataValue& getMetaValue(UInt index, const DataValue& default_value = DataValue::EMPTY) const;
87
89 bool metaValueExists(const String& name) const;
91 bool metaValueExists(UInt index) const;
92
94 void setMetaValue(const String& name, const DataValue& value);
96 void setMetaValue(UInt index, const DataValue& value);
97
99 void removeMetaValue(const String& name);
101 void removeMetaValue(UInt index);
102
104 static MetaInfoRegistry& metaRegistry();
105
107 void getKeys(std::vector<String>& keys) const;
108
110 void getKeys(std::vector<UInt>& keys) const;
111
113 bool isMetaEmpty() const;
114
116 void clearMetaInfo();
117
118 protected:
119
121 inline void createIfNotExists_();
122
124 MetaInfo* meta_;
125 };
126
127 } // namespace OpenMS
128
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::DataValue
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:56
OpenMS::MetaInfoRegistry
Registry which assigns unique integer indices to strings.
Definition: MetaInfoRegistry.h:75
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
Types.h
OpenMS::MetaInfoInterface::meta_
MetaInfo * meta_
Pointer to the MetaInfo object (0 by default)
Definition: MetaInfoInterface.h:124
OpenMS::MetaInfo
A Type-Name-Value tuple class.
Definition: MetaInfo.h:68
MetaInfoRegistry.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
DataValue.h
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::DataValue::EMPTY
static const DataValue EMPTY
Empty data value for comparisons.
Definition: DataValue.h:62
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806