| OpenMS 2.5.0

CVMappingRule.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
40 #include <vector>
41
42 namespace OpenMS
43 {
44 class CVMappingTerm;
45
53 class OPENMS_DLLAPI CVMappingRule
54 {
55 public:
56
58 enum RequirementLevel
59 {
60 MUST = 0,
61 SHOULD = 1,
62 MAY = 2
63 };
64
66 enum CombinationsLogic
67 {
68 OR = 0,
69 AND = 1,
70 XOR = 2
71 };
72
74 CVMappingRule();
75
77 CVMappingRule(const CVMappingRule& rhs);
78
80 virtual ~CVMappingRule();
81
83 CVMappingRule& operator=(const CVMappingRule& rhs);
84
88 void setIdentifier(const String& identifier);
90
92 const String& getIdentifier() const;
93
95 void setElementPath(const String& element_path);
96
98 const String& getElementPath() const;
99
101 void setRequirementLevel(RequirementLevel level);
102
104 RequirementLevel getRequirementLevel() const;
105
107 void setCombinationsLogic(CombinationsLogic combinations_logic);
108
110 CombinationsLogic getCombinationsLogic() const;
111
113 void setScopePath(const String& path);
114
116 const String& getScopePath() const;
117
119 void setCVTerms(const std::vector<CVMappingTerm>& cv_terms);
120
122 const std::vector<CVMappingTerm>& getCVTerms() const;
123
125 void addCVTerm(const CVMappingTerm& cv_terms);
127
131 bool operator==(const CVMappingRule& rhs) const;
133
135 bool operator!=(const CVMappingRule& rhs) const;
137
138 protected:
139
140 String identifier_;
141
142 String element_path_;
143
144 RequirementLevel requirement_level_;
145
146 String scope_path_;
147
148 CombinationsLogic combinations_logic_;
149
150 std::vector<CVMappingTerm> cv_terms_;
151 };
152
153 } // namespace OpenMS
154
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::CVMappingRule::cv_terms_
std::vector< CVMappingTerm > cv_terms_
Definition: CVMappingRule.h:150
OpenMS::CVMappingRule::RequirementLevel
RequirementLevel
enum to specify the requirement level
Definition: CVMappingRule.h:58
OpenMS::CVMappingRule::requirement_level_
RequirementLevel requirement_level_
Definition: CVMappingRule.h:144
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::CVMappingRule::element_path_
String element_path_
Definition: CVMappingRule.h:142
OpenMS::CVMappingRule
Representation of a CV Mapping rule used by CVMappings.
Definition: CVMappingRule.h:53
OpenMS::CVMappingTerm
Representation of controlled vocabulary term.
Definition: CVMappingTerm.h:50
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::CVMappingRule::combinations_logic_
CombinationsLogic combinations_logic_
Definition: CVMappingRule.h:148
OpenMS::CVMappingRule::identifier_
String identifier_
Definition: CVMappingRule.h:140
OpenMS::CVMappingRule::scope_path_
String scope_path_
Definition: CVMappingRule.h:146
OpenMS::CVMappingRule::CombinationsLogic
CombinationsLogic
enum to specify the combination operator
Definition: CVMappingRule.h:66
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806