OpenMS
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-2023.
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>
42 
43 #include <boost/container/flat_map.hpp>
44 
45 namespace OpenMS
46 {
47  class String;
48 
68  class OPENMS_DLLAPI MetaInfo
69  {
70 public:
72  MetaInfo() = default;
73 
75  MetaInfo(const MetaInfo&) = default;
76 
78  MetaInfo(MetaInfo&&) = default;
79 
82 
84  MetaInfo& operator=(const MetaInfo&) = default;
86  MetaInfo& operator=(MetaInfo&&) & = default;
87 
89  bool operator==(const MetaInfo& rhs) const;
91  bool operator!=(const MetaInfo& rhs) const;
92 
94  const DataValue& getValue(const String& name, const DataValue& default_value = DataValue::EMPTY) const;
96  const DataValue& getValue(UInt index, const DataValue& default_value = DataValue::EMPTY) const;
97 
99  bool exists(const String& name) const;
101  bool exists(UInt index) const;
102 
104  void setValue(const String& name, const DataValue& value);
106  void setValue(UInt index, const DataValue& value);
107 
109  void removeValue(const String& name);
111  void removeValue(UInt index);
112 
115 
117  void getKeys(std::vector<String>& keys) const;
118 
120  void getKeys(std::vector<UInt>& keys) const;
121 
123  bool empty() const;
124 
126  void clear();
127 
128 private:
129  using MapType = boost::container::flat_map<UInt, DataValue>;
130 
133 
136  };
137 
138 } // namespace OpenMS
139 
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:59
static const DataValue EMPTY
Empty data value for comparisons.
Definition: DataValue.h:64
Registry which assigns unique integer indices to strings.
Definition: MetaInfoRegistry.h:76
A Type-Name-Value tuple class.
Definition: MetaInfo.h:69
void setValue(UInt index, const DataValue &value)
Sets the DataValue corresponding to an index.
void removeValue(const String &name)
Removes the DataValue corresponding to name if it exists.
const DataValue & getValue(const String &name, const DataValue &default_value=DataValue::EMPTY) const
Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not fo...
MetaInfo(const MetaInfo &)=default
Copy constructor.
bool operator!=(const MetaInfo &rhs) const
Equality operator.
~MetaInfo()
Destructor.
bool empty() const
Returns if the MetaInfo is empty.
void removeValue(UInt index)
Removes the DataValue corresponding to index if it exists.
bool operator==(const MetaInfo &rhs) const
Equality operator.
bool exists(const String &name) const
Returns whether an entry with the given name exists.
MapType index_to_value_
The actual mapping of indexes to values.
Definition: MetaInfo.h:135
void getKeys(std::vector< String > &keys) const
Fills the given vector with a list of all keys for which a value is set.
void getKeys(std::vector< UInt > &keys) const
Fills the given vector with a list of all keys for which a value is set.
boost::container::flat_map< UInt, DataValue > MapType
Definition: MetaInfo.h:129
MetaInfo()=default
Constructor.
void setValue(const String &name, const DataValue &value)
Sets the DataValue corresponding to a name.
static MetaInfoRegistry & registry()
Returns a reference to the MetaInfoRegistry.
MetaInfo(MetaInfo &&)=default
Move constructor.
static MetaInfoRegistry registry_
Static MetaInfoRegistry.
Definition: MetaInfo.h:132
void clear()
Removes all meta values.
MetaInfo & operator=(const MetaInfo &)=default
Assignment operator.
MetaInfo & operator=(MetaInfo &&) &=default
Move assignment operator.
const DataValue & getValue(UInt index, const DataValue &default_value=DataValue::EMPTY) const
Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not fo...
bool exists(UInt index) const
Returns whether an entry with the given index exists.
A more convenient string class.
Definition: String.h:60
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48