| OpenMS 2.5.0

CVMappings.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: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/OpenMSConfig.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39 #include <map>
40 #include <vector>
41
42 namespace OpenMS
43 {
44 class CVMappingRule;
45 class CVReference;
46
56 class OPENMS_DLLAPI CVMappings
57 {
58 public:
59
61 CVMappings();
62
64 CVMappings(const CVMappings& rhs);
65
67 virtual ~CVMappings();
68
70 CVMappings& operator=(const CVMappings& rhs);
71
75 void setMappingRules(const std::vector<CVMappingRule>& cv_mapping_rules);
77
79 const std::vector<CVMappingRule>& getMappingRules() const;
80
82 void addMappingRule(const CVMappingRule& cv_mapping_rule);
83
85 void setCVReferences(const std::vector<CVReference>& cv_references);
86
88 const std::vector<CVReference>& getCVReferences() const;
89
91 void addCVReference(const CVReference& cv_reference);
93
97 bool hasCVReference(const String& identifier);
99
101 bool operator==(const CVMappings& rhs) const;
102
104 bool operator!=(const CVMappings& rhs) const;
106
107 protected:
108
109 std::vector<CVMappingRule> mapping_rules_;
110
111 std::map<String, CVReference> cv_references_;
112
113 std::vector<CVReference> cv_references_vector_;
114 };
115 } // namespace OpenMS
116
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::CVMappings
Representation of controlled vocabulary mapping rules (for PSI formats)
Definition: CVMappings.h:56
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::CVReference
Controlled Vocabulary Reference.
Definition: CVReference.h:52
OpenMS::CVMappingRule
Representation of a CV Mapping rule used by CVMappings.
Definition: CVMappingRule.h:53
OpenMS::CVMappings::mapping_rules_
std::vector< CVMappingRule > mapping_rules_
Definition: CVMappings.h:109
OpenMS::CVMappings::cv_references_vector_
std::vector< CVReference > cv_references_vector_
Definition: CVMappings.h:113
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::CVMappings::cv_references_
std::map< String, CVReference > cv_references_
Definition: CVMappings.h:111
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806