OpenMS
Software.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: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 namespace OpenMS
42 {
48  class OPENMS_DLLAPI Software :
49  public CVTermList
50  {
51 public:
53  explicit Software(const String& name = "", const String& version = "");
55  Software(const Software&) = default;
57  Software(Software&&) = default;
59  ~Software() override;
60 
62  Software& operator=(const Software&) = default;
64  Software& operator=(Software&&)& = default;
65 
67  bool operator==(const Software& rhs) const;
69  bool operator!=(const Software& rhs) const;
71  bool operator<(const Software& rhs) const;
72 
74  const String& getName() const;
76  void setName(const String& name);
77 
79  const String& getVersion() const;
81  void setVersion(const String& version);
82 
83 protected:
86  };
87 } // namespace OpenMS
88 
Representation of controlled vocabulary term list.
Definition: CVTermList.h:54
Description of the software used for processing.
Definition: Software.h:50
bool operator==(const Software &rhs) const
Equality operator.
Software(Software &&)=default
Move constructor.
Software(const String &name="", const String &version="")
Constructor.
String name_
Definition: Software.h:84
const String & getVersion() const
Returns the software version.
String version_
Definition: Software.h:85
void setName(const String &name)
Sets the name of the software.
bool operator<(const Software &rhs) const
Less-than operator (for sorting)
bool operator!=(const Software &rhs) const
Inequality operator.
const String & getName() const
Returns the name of the software.
Software & operator=(Software &&) &=default
Move assignment operator.
Software & operator=(const Software &)=default
Assignment operator.
~Software() override
Destructor.
Software(const Software &)=default
Copy constructor.
void setVersion(const String &version)
Sets the software version.
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48