OpenMS  3.0.0
RichPeak2D.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-2022.
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 
37 #include <OpenMS/KERNEL/Peak2D.h>
40 
41 namespace OpenMS
42 {
43 
52  class OPENMS_DLLAPI RichPeak2D :
53  public Peak2D,
54  public MetaInfoInterface,
55  public UniqueIdInterface
56  {
57 public:
58 
61  Peak2D(),
64  {}
65 
67  RichPeak2D(const RichPeak2D& p) = default;
68 
70  explicit RichPeak2D(const Peak2D& p) :
71  Peak2D(p),
73  {
75  }
76 
78  explicit RichPeak2D(const PositionType& pos, const IntensityType in) :
79  Peak2D(pos, in),
81  {}
82 
84  RichPeak2D(RichPeak2D&& p) = default;
85 
87  ~RichPeak2D() override
88  {}
89 
91  RichPeak2D & operator=(const RichPeak2D& rhs) = default;
92 
94  RichPeak2D & operator=(RichPeak2D&& rhs) & = default;
95 
97  RichPeak2D & operator=(const Peak2D& rhs)
98  {
99  if (this == &rhs) return *this;
100 
101  Peak2D::operator=(rhs);
102  clearMetaInfo();
104 
105  return *this;
106  }
107 
109  bool operator==(const RichPeak2D& rhs) const
110  {
111  return Peak2D::operator==(rhs) &&
114  }
115 
117  bool operator!=(const RichPeak2D& rhs) const
118  {
119  return !(operator==(rhs));
120  }
121 
122  };
123 
124 } // namespace OpenMS
125 
OpenMS::RichPeak2D::RichPeak2D
RichPeak2D(const PositionType &pos, const IntensityType in)
Member constructor.
Definition: RichPeak2D.h:78
UniqueIdInterface.h
OpenMS::Peak2D
A 2-dimensional raw data point or peak.
Definition: Peak2D.h:54
OpenMS::MetaInfoInterface::operator==
bool operator==(const MetaInfoInterface &rhs) const
Equality operator.
OpenMS::RichPeak2D::RichPeak2D
RichPeak2D(const Peak2D &p)
Constructor from Peak2D.
Definition: RichPeak2D.h:70
OpenMS::UniqueIdInterface
A base class defining a common interface for all classes having a unique id.
Definition: UniqueIdInterface.h:50
OpenMS::UniqueIdInterface::clearUniqueId
Size clearUniqueId()
Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed,...
Definition: UniqueIdInterface.h:111
OpenMS::RichPeak2D
A 2-dimensional raw data point or peak with meta information.
Definition: RichPeak2D.h:52
OpenMS::Peak2D::operator=
Peak2D & operator=(const Peak2D &rhs)=default
Assignment operator.
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::RichPeak2D::operator!=
bool operator!=(const RichPeak2D &rhs) const
Equality operator.
Definition: RichPeak2D.h:117
Peak2D.h
OpenMS::RichPeak2D::operator==
bool operator==(const RichPeak2D &rhs) const
Equality operator.
Definition: RichPeak2D.h:109
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::Peak2D::operator==
bool operator==(const Peak2D &rhs) const
Equality operator.
Definition: Peak2D.h:228
OpenMS::RichPeak2D::operator=
RichPeak2D & operator=(const Peak2D &rhs)
Assignment operator.
Definition: RichPeak2D.h:97
OpenMS::DPosition< 2 >
OpenMS::RichPeak2D::RichPeak2D
RichPeak2D()
Default constructor.
Definition: RichPeak2D.h:60
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)
float
MetaInfoInterface.h
OpenMS::UniqueIdInterface::operator==
bool operator==(UniqueIdInterface const &rhs) const
Equality comparison operator - the unique ids must be equal (!)
Definition: UniqueIdInterface.h:97
OpenMS::RichPeak2D::~RichPeak2D
~RichPeak2D() override
Destructor.
Definition: RichPeak2D.h:87