| OpenMS 2.5.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-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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/METADATA/MetaInfoInterface.h>
38 #include <OpenMS/METADATA/CVTerm.h>
39 #include <OpenMS/DATASTRUCTURES/Map.h>
40
41 namespace OpenMS
42 {
43
44 class CVTermList;
45
57 class OPENMS_DLLAPI CVTermListInterface :
58 public MetaInfoInterface
59 {
60
61 public:
62
66 // Constructor
67 CVTermListInterface();
69 CVTermListInterface(const CVTermListInterface & rhs);
71 CVTermListInterface(CVTermListInterface&&) noexcept;
72 // Destructor (non virtual)
73 ~CVTermListInterface();
74
76 CVTermListInterface & operator=(const CVTermListInterface & rhs);
78 CVTermListInterface& operator=(CVTermListInterface&&) noexcept;
80
82 bool operator==(const CVTermListInterface& rhs) const;
83
85 bool operator!=(const CVTermListInterface& rhs) const;
86
87 void replaceCVTerms(Map<String, std::vector<CVTerm> > & cv_terms);
88
90 void setCVTerms(const std::vector<CVTerm>& terms);
91
93 void replaceCVTerm(const CVTerm& cv_term);
94
96 void replaceCVTerms(const std::vector<CVTerm>& cv_terms, const String& accession);
97
99 void replaceCVTerms(const Map<String, std::vector<CVTerm> >& cv_term_map);
100
102 void consumeCVTerms(const Map<String, std::vector<CVTerm> >& cv_term_map);
103
105 const Map<String, std::vector<CVTerm> >& getCVTerms() const;
106
108 void addCVTerm(const CVTerm& term);
109
111 bool hasCVTerm(const String& accession) const;
112
113 bool empty() const;
114
115 private:
116
117 void createIfNotExists_();
118
119 CVTermList* cvt_ptr_;
120 };
121
122 } // namespace OpenMS
123
OpenMS::CVTermList
Representation of controlled vocabulary term list.
Definition: CVTermList.h:52
OpenMS::String
A more convenient string class.
Definition: String.h:58
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
CVTerm.h
OpenMS::CVTermListInterface
Interface to the controlled vocabulary term list.
Definition: CVTermListInterface.h:57
OpenMS::CVTerm
Representation of controlled vocabulary term.
Definition: CVTerm.h:52
OpenMS::Map
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
Map.h
MetaInfoInterface.h
OpenMS::CVTermListInterface::cvt_ptr_
CVTermList * cvt_ptr_
Definition: CVTermListInterface.h:119
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806