Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_KERNEL_RICHPEAK2D_H
36 #define OPENMS_KERNEL_RICHPEAK2D_H
37 
38 #include <OpenMS/KERNEL/Peak2D.h>
41 
42 namespace OpenMS
43 {
44 
53  class OPENMS_DLLAPI RichPeak2D :
54  public Peak2D,
55  public MetaInfoInterface,
56  public UniqueIdInterface
57  {
58 public:
59 
62  Peak2D(),
65  {}
66 
68  RichPeak2D(const RichPeak2D& p) :
69  Peak2D(p),
72  {}
73 
75  explicit RichPeak2D(const Peak2D& p) :
76  Peak2D(p),
78  {
80  }
81 
83  explicit RichPeak2D(const PositionType& pos, const IntensityType in) :
84  Peak2D(pos, in),
86  {}
87 
90  {}
91 
94  {
95  if (this == &rhs) return *this;
96 
97  Peak2D::operator=(rhs);
100 
101  return *this;
102  }
103 
106  {
107  if (this == &rhs) return *this;
108 
109  Peak2D::operator=(rhs);
110  clearMetaInfo();
112 
113  return *this;
114  }
115 
117  bool operator==(const RichPeak2D& rhs) const
118  {
119  return Peak2D::operator==(rhs) &&
122  }
123 
125  bool operator!=(const RichPeak2D& rhs) const
126  {
127  return !(operator==(rhs));
128  }
129 
130  };
131 
132 } // namespace OpenMS
133 
134 #endif // OPENMS_KERNEL_RICHPEAK2D_H
bool operator==(const MetaInfoInterface &rhs) const
Equality operator.
RichPeak2D(const RichPeak2D &p)
Copy constructor.
Definition: RichPeak2D.h:68
A 2-dimensional raw data point or peak.
Definition: Peak2D.h:55
RichPeak2D(const Peak2D &p)
Constructor from Peak2D.
Definition: RichPeak2D.h:75
bool operator==(const RichPeak2D &rhs) const
Equality operator.
Definition: RichPeak2D.h:117
RichPeak2D(const PositionType &pos, const IntensityType in)
Member constructor.
Definition: RichPeak2D.h:83
Peak2D & operator=(const Peak2D &rhs)
Assignment operator.
Definition: Peak2D.h:223
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Size clearUniqueId()
Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed...
Definition: UniqueIdInterface.h:117
bool operator!=(const RichPeak2D &rhs) const
Equality operator.
Definition: RichPeak2D.h:125
RichPeak2D & operator=(const RichPeak2D &rhs)
Assignment operator.
Definition: RichPeak2D.h:93
~RichPeak2D()
Destructor.
Definition: RichPeak2D.h:89
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:56
RichPeak2D()
Default constructor.
Definition: RichPeak2D.h:61
A base class defining a common interface for all classes having a unique id.
Definition: UniqueIdInterface.h:52
MetaInfoInterface & operator=(const MetaInfoInterface &rhs)
Assignment operator.
bool operator==(UniqueIdInterface const &rhs) const
Equality comparison operator - the unique ids must be equal (!)
Definition: UniqueIdInterface.h:103
A 2-dimensional raw data point or peak with meta information.
Definition: RichPeak2D.h:53
UniqueIdInterface & operator=(UniqueIdInterface const &rhs)
Assignment operator - copies the unique id.
Definition: UniqueIdInterface.h:90
RichPeak2D & operator=(const Peak2D &rhs)
Assignment operator.
Definition: RichPeak2D.h:105
bool operator==(const Peak2D &rhs) const
Equality operator.
Definition: Peak2D.h:234

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:03 using doxygen 1.8.13