OpenMS
CVReference.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 
37 #include <OpenMS/OpenMSConfig.h>
39 
40 #include <vector>
41 
42 namespace OpenMS
43 {
52  class OPENMS_DLLAPI CVReference
53  {
54 public:
55 
58 
60  CVReference(const CVReference& rhs);
61 
63  virtual ~CVReference();
64 
67 
72  void setName(const String& name);
73 
75  const String& getName() const;
76 
78  void setIdentifier(const String& identifier);
79 
81  const String& getIdentifier() const;
83 
88  bool operator==(const CVReference& rhs) const;
89 
91  bool operator!=(const CVReference& rhs) const;
93 
94 
95 protected:
96 
98 
100  };
101 
102 
103 } // namespace OpenMS
104 
Controlled Vocabulary Reference.
Definition: CVReference.h:53
const String & getIdentifier() const
returns the CV identifier which is referenced
bool operator==(const CVReference &rhs) const
equality operator
virtual ~CVReference()
Destructor.
void setIdentifier(const String &identifier)
sets the CV identifier which is referenced
String name_
Definition: CVReference.h:97
CVReference()
Default constructor.
void setName(const String &name)
sets the name of the CV reference
CVReference & operator=(const CVReference &rhs)
Assignment operator.
const String & getName() const
returns the name of the CV reference
bool operator!=(const CVReference &rhs) const
inequality operator
CVReference(const CVReference &rhs)
Copy constructor.
String identifier_
Definition: CVReference.h:99
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48