| OpenMS 2.5.0

MetaInfoRegistry.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: Hendrik Weisser $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <map>
38 #include <string>
39
40 #include <OpenMS/CONCEPT/Exception.h>
41 #include <OpenMS/CONCEPT/Types.h>
42 #include <OpenMS/DATASTRUCTURES/String.h>
43
44 #include <unordered_map>
45
46 #ifdef OPENMS_COMPILER_MSVC
47 #pragma warning( push )
48 #pragma warning( disable : 4251 ) // disable MSVC dll-interface warning
49 #endif
50
51 namespace OpenMS
52 {
53
75 class OPENMS_DLLAPI MetaInfoRegistry
76 {
77 public:
79 MetaInfoRegistry();
80
82 MetaInfoRegistry(const MetaInfoRegistry& rhs);
83
85 ~MetaInfoRegistry();
86
88 MetaInfoRegistry& operator=(const MetaInfoRegistry& rhs);
89
94 UInt registerName(const String& name, const String& description = "", const String& unit = "");
95
101 void setDescription(UInt index, const String& description);
102
108 void setDescription(const String& name, const String& description);
109
115 void setUnit(UInt index, const String& unit);
116
122 void setUnit(const String& name, const String& unit);
123
128 UInt getIndex(const String& name) const;
129
135 String getName(UInt index) const;
136
142 String getDescription(UInt index) const;
148 String getDescription(const String& name) const;
149
155 String getUnit(UInt index) const;
161 String getUnit(const String& name) const;
162
163 private:
165 UInt next_index_;
166 using MapString2IndexType = std::unordered_map<std::string, UInt>;
167 using MapIndex2StringType = std::unordered_map<UInt, std::string>;
168
170 MapString2IndexType name_to_index_;
172 MapIndex2StringType index_to_name_;
174 MapIndex2StringType index_to_description_;
176 MapIndex2StringType index_to_unit_;
177 };
178
179 } // namespace OpenMS
180
181 #ifdef OPENMS_COMPILER_MSVC
182 #pragma warning( pop )
183 #endif
184
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MetaInfoRegistry::index_to_unit_
MapIndex2StringType index_to_unit_
map from index to unit
Definition: MetaInfoRegistry.h:176
OpenMS::MetaInfoRegistry::index_to_description_
MapIndex2StringType index_to_description_
map from index to description
Definition: MetaInfoRegistry.h:174
OpenMS::MetaInfoRegistry
Registry which assigns unique integer indices to strings.
Definition: MetaInfoRegistry.h:75
Exception.h
OpenMS::MetaInfoRegistry::index_to_name_
MapIndex2StringType index_to_name_
map from index to name
Definition: MetaInfoRegistry.h:172
Types.h
OpenMS::MetaInfoRegistry::next_index_
UInt next_index_
internal counter, that stores the next index to assign
Definition: MetaInfoRegistry.h:165
OpenMS::MetaInfoRegistry::MapString2IndexType
std::unordered_map< std::string, UInt > MapString2IndexType
Definition: MetaInfoRegistry.h:166
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MetaInfoRegistry::name_to_index_
MapString2IndexType name_to_index_
map from name to index
Definition: MetaInfoRegistry.h:170
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::MetaInfoRegistry::MapIndex2StringType
std::unordered_map< UInt, std::string > MapIndex2StringType
Definition: MetaInfoRegistry.h:167