Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_DATASTRUCTURES_CVMAPPINGS_H
36 #define OPENMS_DATASTRUCTURES_CVMAPPINGS_H
37 
38 #include <OpenMS/OpenMSConfig.h>
40 #include <map>
41 #include <vector>
42 
43 namespace OpenMS
44 {
45  class CVMappingRule;
46  class CVReference;
47 
57  class OPENMS_DLLAPI CVMappings
58  {
59 public:
60 
62  CVMappings();
63 
65  CVMappings(const CVMappings& rhs);
66 
68  virtual ~CVMappings();
69 
71  CVMappings& operator=(const CVMappings& rhs);
72 
76  void setMappingRules(const std::vector<CVMappingRule>& cv_mapping_rules);
78 
80  const std::vector<CVMappingRule>& getMappingRules() const;
81 
83  void addMappingRule(const CVMappingRule& cv_mapping_rule);
84 
86  void setCVReferences(const std::vector<CVReference>& cv_references);
87 
89  const std::vector<CVReference>& getCVReferences() const;
90 
92  void addCVReference(const CVReference& cv_reference);
94 
98  bool hasCVReference(const String& identifier);
100 
102  bool operator==(const CVMappings& rhs) const;
103 
105  bool operator!=(const CVMappings& rhs) const;
107 
108 protected:
109 
110  std::vector<CVMappingRule> mapping_rules_;
111 
112  std::map<String, CVReference> cv_references_;
113 
114  std::vector<CVReference> cv_references_vector_;
115  };
116 } // namespace OpenMS
117 
118 #endif // OPENMS_DATASTRUCTURES_CVMAPPINGS_H
std::vector< CVReference > cv_references_vector_
Definition: CVMappings.h:114
A more convenient string class.
Definition: String.h:57
std::map< String, CVReference > cv_references_
Definition: CVMappings.h:112
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
std::vector< CVMappingRule > mapping_rules_
Definition: CVMappings.h:110
Representation of a CV Mapping rule used by CVMappings.
Definition: CVMappingRule.h:54
Controlled Vocabulary Reference.
Definition: CVReference.h:53
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
Representation of controlled vocabulary mapping rules (for PSI formats)
Definition: CVMappings.h:57

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13