OpenMS
SampleTreatment.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, 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: Marc Sturm $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
13 
14 namespace OpenMS
15 {
25  class OPENMS_DLLAPI SampleTreatment :
26  public MetaInfoInterface
27  {
28 public:
29 
35  explicit SampleTreatment(const String & type);
36 
42  SampleTreatment(const SampleTreatment &) = default;
43 
46 
48  virtual ~SampleTreatment();
49 
56 
59 
68  virtual bool operator==(const SampleTreatment & rhs) const;
69 
76  const String & getType() const;
77 
79  const String & getComment() const;
80 
82  void setComment(const String & comment);
83 
90  virtual SampleTreatment * clone() const = 0;
91 
92 protected:
95 
96 private:
99 
100  };
101 } // namespace OpenMS
102 
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:35
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Definition: SampleTreatment.h:27
String comment_
Definition: SampleTreatment.h:94
String type_
Definition: SampleTreatment.h:93
void setComment(const String &comment)
sets the description of the sample treatment
SampleTreatment()
Default constructor hidden to force setting of a type.
virtual SampleTreatment * clone() const =0
A clone method.
virtual bool operator==(const SampleTreatment &rhs) const
virtual ~SampleTreatment()
Destructor.
SampleTreatment & operator=(const SampleTreatment &)=default
Assignment operator.
SampleTreatment(const SampleTreatment &)=default
Copy constructor.
const String & getType() const
return the treatment type
const String & getComment() const
returns the description of the sample treatment
SampleTreatment(const String &type)
Constructor.
SampleTreatment(SampleTreatment &&)=default
Move constructor.
SampleTreatment & operator=(SampleTreatment &&) &=default
Move assignment operator.
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19