OpenMS  3.0.0
CVTermList.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-2022.
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: Mathias Walzer $
32 // $Authors: Andreas Bertsch, Mathias Walzer $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/METADATA/CVTerm.h>
39 #include <map>
40 
41 namespace OpenMS
42 {
51  class OPENMS_DLLAPI CVTermList :
53  public MetaInfoInterface
54  {
55 public:
56 
58  CVTermList() = default;
59 
61  CVTermList(const CVTermList&) = default;
62 
63  // note: we implement the move constructor ourselves due to a bug in MSVS
64  // 2015/2017 which cannot produce a default move constructor for classes
65  // that contain STL containers (other than vector).
66 
68  CVTermList(CVTermList&&) noexcept;
69 
71  virtual ~CVTermList();
72 
74  CVTermList& operator=(const CVTermList& rhs) & = default;
75 
77  CVTermList& operator=(CVTermList&&) & = default;
78 
82  void setCVTerms(const std::vector<CVTerm>& terms);
84 
86  void replaceCVTerm(const CVTerm& cv_term);
87 
89  void replaceCVTerms(const std::vector<CVTerm>& cv_terms, const String& accession);
90 
92  void replaceCVTerms(const std::map<String, std::vector<CVTerm> >& cv_term_map);
93 
95  void consumeCVTerms(const std::map<String, std::vector<CVTerm> >& cv_term_map);
96 
98  const std::map<String, std::vector<CVTerm> >& getCVTerms() const;
99 
101  void addCVTerm(const CVTerm& term);
102 
104  //bool checkCVTerms(const ControlledVocabulary& cv) const;
105 
107  //void correctCVTermNames();
109 
113  bool operator==(const CVTermList& cv_term_list) const;
115 
117  bool operator!=(const CVTermList& cv_term_list) const;
118 
120  bool hasCVTerm(const String& accession) const;
121 
124  //bool checkCVTerms(const CVMappingRule & rule, const ControlledVocabulary & cv) const;
125 
127  bool empty() const;
128  //}
129 
130 protected:
131 
132  std::map<String, std::vector<CVTerm> > cv_terms_;
133 
134  };
135 
136 } // namespace OpenMS
137 
CVTerm.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::CVTerm
Representation of controlled vocabulary term.
Definition: CVTerm.h:52
MetaInfoInterface.h