OpenMS  2.4.0
CVTermListInterface.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-2018.
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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <OpenMS/METADATA/CVTerm.h>
40 
41 namespace OpenMS
42 {
43 
44  class CVTermList;
45 
57  class OPENMS_DLLAPI CVTermListInterface :
59  public MetaInfoInterface
60  {
61 
62  public:
63 
64  CVTermListInterface();
65 
66  CVTermListInterface(const CVTermListInterface & rhs);
67 
68  // Destructor (non virtual)
69  ~CVTermListInterface();
70 
72  CVTermListInterface & operator=(const CVTermListInterface & rhs);
73 
75  bool operator==(const CVTermListInterface& rhs) const;
76 
78  bool operator!=(const CVTermListInterface& rhs) const;
79 
80  void replaceCVTerms(Map<String, std::vector<CVTerm> > & cv_terms);
81 
83  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 Map<String, std::vector<CVTerm> >& cv_term_map);
93 
95  void consumeCVTerms(const Map<String, std::vector<CVTerm> >& cv_term_map);
96 
98  const Map<String, std::vector<CVTerm> >& getCVTerms() const;
99 
101  void addCVTerm(const CVTerm& term);
102 
104  bool hasCVTerm(const String& accession) const;
105 
106  bool empty() const;
107 
108  private:
109 
110  void createIfNotExists_();
111 
113  };
114 
115 } // namespace OpenMS
116 
117 
Representation of controlled vocabulary term list.
Definition: CVTermList.h:52
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
CVTermList * cvt_ptr_
Definition: CVTermListInterface.h:112
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824