Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2013.
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: Andreas Bertsch $
32 // $Authors: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_DATASTRUCTURES_CVMAPPINGRULE_H
36 #define OPENMS_DATASTRUCTURES_CVMAPPINGRULE_H
37 
40 #include <vector>
41 
42 namespace OpenMS
43 {
51  class OPENMS_DLLAPI CVMappingRule
52  {
53 public:
54 
57  {
58  MUST = 0,
59  SHOULD = 1,
60  MAY = 2
61  };
62 
65  {
66  OR = 0,
67  AND = 1,
68  XOR = 2
69  };
70 
72  CVMappingRule();
73 
75  CVMappingRule(const CVMappingRule & rhs);
76 
78  virtual ~CVMappingRule();
79 
81  CVMappingRule & operator=(const CVMappingRule & rhs);
82 
86  void setIdentifier(const String & identifier);
88 
90  const String & getIdentifier() const;
91 
93  void setElementPath(const String & element_path);
94 
96  const String & getElementPath() const;
97 
99  void setRequirementLevel(RequirementLevel level);
100 
102  RequirementLevel getRequirementLevel() const;
103 
105  void setCombinationsLogic(CombinationsLogic combinations_logic);
106 
108  CombinationsLogic getCombinationsLogic() const;
109 
111  void setScopePath(const String & path);
112 
114  const String & getScopePath() const;
115 
117  void setCVTerms(const std::vector<CVMappingTerm> & cv_terms);
118 
120  const std::vector<CVMappingTerm> & getCVTerms() const;
121 
123  void addCVTerm(const CVMappingTerm & cv_terms);
125 
129  bool operator==(const CVMappingRule & rhs) const;
131 
133  bool operator!=(const CVMappingRule & rhs) const;
135 
136 protected:
137 
139 
141 
143 
145 
147 
148  std::vector<CVMappingTerm> cv_terms_;
149  };
150 
151 } // namespace OpenMS
152 
153 #endif // OPENMS_DATASTRUCTURES_CVMAPPINGRULE_H
A more convenient string class.
Definition: String.h:56
String scope_path_
Definition: CVMappingRule.h:144
CombinationsLogic
enum to specify the combination operator
Definition: CVMappingRule.h:64
std::vector< CVMappingTerm > cv_terms_
Definition: CVMappingRule.h:148
Representation of controlled vocabulary term.
Definition: CVMappingTerm.h:50
RequirementLevel requirement_level_
Definition: CVMappingRule.h:142
Representation of a CV Mapping rule used by CVMappings.
Definition: CVMappingRule.h:51
String identifier_
Definition: CVMappingRule.h:138
CombinationsLogic combinations_logic_
Definition: CVMappingRule.h:146
RequirementLevel
enum to specify the requirement level
Definition: CVMappingRule.h:56
String element_path_
Definition: CVMappingRule.h:140

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:12 using doxygen 1.8.5