Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-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_METADATA_CVTERMLIST_H
36 #define OPENMS_METADATA_CVTERMLIST_H
37 
38 #include <OpenMS/METADATA/CVTerm.h>
42 
43 namespace OpenMS
44 {
53  class OPENMS_DLLAPI CVTermList :
55  public MetaInfoInterface
56  {
57 public:
58 
60  CVTermList();
61 
63  CVTermList(const CVTermList & rhs);
64 
66  virtual ~CVTermList();
67 
69  CVTermList & operator=(const CVTermList & rhs);
70 
74  void setCVTerms(const std::vector<CVTerm> & terms);
76 
78  void replaceCVTerm(const CVTerm & cv_term);
79 
81  void replaceCVTerms(const std::vector<CVTerm> & cv_terms, const String & accession);
82 
84  void replaceCVTerms(const Map<String, std::vector<CVTerm> > & cv_term_map);
85 
87  const Map<String, std::vector<CVTerm> > & getCVTerms() const;
88 
90  void addCVTerm(const CVTerm & term);
91 
93  //bool checkCVTerms(const ControlledVocabulary& cv) const;
94 
96  //void correctCVTermNames();
98 
102  bool operator==(const CVTermList & cv_term_list) const;
104 
106  bool operator!=(const CVTermList & cv_term_list) const;
107 
109  bool hasCVTerm(const String & accession) const;
110 
113  //bool checkCVTerms(const CVMappingRule & rule, const ControlledVocabulary & cv) const;
114 
116  bool empty() const;
117  //}
118 
119 protected:
120 
122 
123  };
124 
125 } // namespace OpenMS
126 
127 #endif // OPENMS_DATASTRUCTURES_CVTERMLIST_H
Map< String, std::vector< CVTerm > > cv_terms_
Definition: CVTermList.h:121
Map class based on the STL map (containing serveral convenience functions)
Definition: Map.h:50

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