OpenMS
CVMappingTerm.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-2023.
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 #pragma once
36 
38 #include <OpenMS/OpenMSConfig.h>
39 
40 namespace OpenMS
41 {
50  class OPENMS_DLLAPI CVMappingTerm
51  {
52 public:
53 
56 
59 
61  virtual ~CVMappingTerm();
62 
65 
70  void setAccession(const String& accession);
71 
73  const String& getAccession() const;
74 
76  void setUseTermName(bool use_term_name);
77 
79  bool getUseTermName() const;
80 
82  void setUseTerm(bool use_term);
83 
85  bool getUseTerm() const;
86 
88  void setTermName(const String& term_name);
89 
91  const String& getTermName() const;
92 
94  void setIsRepeatable(bool is_repeatable);
95 
97  bool getIsRepeatable() const;
98 
100  void setAllowChildren(bool allow_children);
101 
103  bool getAllowChildren() const;
104 
106  void setCVIdentifierRef(const String& cv_identifier_ref);
107 
109  const String& getCVIdentifierRef() const;
111 
116  bool operator==(const CVMappingTerm& rhs) const;
117 
119  bool operator!=(const CVMappingTerm& rhs) const;
120  //}
121 
122 protected:
123 
125 
127 
128  bool use_term_;
129 
131 
133 
135 
137  };
138 
139 } // namespace OpenMS
140 
Representation of controlled vocabulary term.
Definition: CVMappingTerm.h:51
const String & getCVIdentifierRef() const
returns the cv identifier reference string
String term_name_
Definition: CVMappingTerm.h:130
void setUseTermName(bool use_term_name)
sets whether the term name should be used, instead of the accession
void setIsRepeatable(bool is_repeatable)
sets whether this term can be repeated
bool use_term_name_
Definition: CVMappingTerm.h:126
CVMappingTerm()
Defaults constructor.
void setTermName(const String &term_name)
sets the name of the term
bool is_repeatable_
Definition: CVMappingTerm.h:132
bool getUseTermName() const
returns whether the term name should be used, instead of the accession
CVMappingTerm(const CVMappingTerm &rhs)
Copy constructor.
const String & getTermName() const
returns the name of the term
void setCVIdentifierRef(const String &cv_identifier_ref)
sets the cv identifier reference string, e.g. UO for unit obo
bool getAllowChildren() const
returns true if the children of this term are allowed to be used
bool use_term_
Definition: CVMappingTerm.h:128
bool allow_children_
Definition: CVMappingTerm.h:134
bool operator!=(const CVMappingTerm &rhs) const
inequality operator
const String & getAccession() const
returns the accession string of the term
void setAllowChildren(bool allow_children)
sets whether children of this term are allowed
void setUseTerm(bool use_term)
sets whether the term itself can be used (or only its children)
String accession_
Definition: CVMappingTerm.h:124
bool getIsRepeatable() const
returns true if this term can be repeated, false otherwise
CVMappingTerm & operator=(const CVMappingTerm &rhs)
Assignment operator.
void setAccession(const String &accession)
sets the accession string of the term
bool operator==(const CVMappingTerm &rhs) const
equality operator
String cv_identifier_ref_
Definition: CVMappingTerm.h:136
bool getUseTerm() const
returns true if the term can be used, false if only children are allowed
virtual ~CVMappingTerm()
Destructor.
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48