OpenMS
CVMappingTerm.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Andreas Bertsch $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 #include <OpenMS/OpenMSConfig.h>
13 
14 namespace OpenMS
15 {
24  class OPENMS_DLLAPI CVMappingTerm
25  {
26 public:
27 
30 
33 
35  virtual ~CVMappingTerm();
36 
39 
44  void setAccession(const String& accession);
45 
47  const String& getAccession() const;
48 
50  void setUseTermName(bool use_term_name);
51 
53  bool getUseTermName() const;
54 
56  void setUseTerm(bool use_term);
57 
59  bool getUseTerm() const;
60 
62  void setTermName(const String& term_name);
63 
65  const String& getTermName() const;
66 
68  void setIsRepeatable(bool is_repeatable);
69 
71  bool getIsRepeatable() const;
72 
74  void setAllowChildren(bool allow_children);
75 
77  bool getAllowChildren() const;
78 
80  void setCVIdentifierRef(const String& cv_identifier_ref);
81 
83  const String& getCVIdentifierRef() const;
85 
90  bool operator==(const CVMappingTerm& rhs) const;
91 
93  bool operator!=(const CVMappingTerm& rhs) const;
94  //}
95 
96 protected:
97 
99 
101 
102  bool use_term_;
103 
105 
107 
109 
111  };
112 
113 } // namespace OpenMS
114 
Representation of controlled vocabulary term.
Definition: CVMappingTerm.h:25
const String & getCVIdentifierRef() const
returns the cv identifier reference string
String term_name_
Definition: CVMappingTerm.h:104
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:100
CVMappingTerm()
Defaults constructor.
void setTermName(const String &term_name)
sets the name of the term
bool is_repeatable_
Definition: CVMappingTerm.h:106
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:102
bool allow_children_
Definition: CVMappingTerm.h:108
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:98
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:110
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:34
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22