Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

PrecursorPeak Class Template Reference

#include <OpenMS/KERNEL/DSpectrum.h>

Inheritance diagram for PrecursorPeak:

DPeak DRawDataPoint MetaInfoInterface

List of all members.


Detailed Description

template<UInt D>
class OpenMS::Internal::PrecursorPeak< D >

Internal class used to store some information about precursor ions.

This class is designed for limited use cases, such as storing precursor information from DTA files. No data processing! In particular does not interact well with classes like Peak1D or Peak2D.

Public Types

enum  { DIMENSION = D }
 Dimensionality. More...
typedef Int ChargeType
 Charge Type.

Public Member Functions

 PrecursorPeak ()
 Default constructor.
 PrecursorPeak (const PrecursorPeak &rhs)
 Copy constructor.
PrecursorPeakoperator= (const PrecursorPeak &rhs)
 Assignment operator.
 ~PrecursorPeak ()
 Destructor.
ChargeType const & getCharge () const
 Non-mutable access to the charge.
void setCharge (ChargeType charge)
 Mutable access to the charge.

Protected Attributes

ChargeType charge_

Private Types

typedef DPeak< D > Base
 Base class (do not even think of using this outside the scope of this class).


Member Typedef Documentation

typedef DPeak<D> Base [private]

Base class (do not even think of using this outside the scope of this class).

typedef Int ChargeType

Charge Type.


Member Enumeration Documentation

anonymous enum

Dimensionality.

Enumerator:
DIMENSION 


Constructor & Destructor Documentation

PrecursorPeak (  )  [inline]

Default constructor.

PrecursorPeak ( const PrecursorPeak< D > &  rhs  )  [inline]

Copy constructor.

~PrecursorPeak (  )  [inline]

Destructor.


Member Function Documentation

PrecursorPeak& operator= ( const PrecursorPeak< D > &  rhs  )  [inline]

Assignment operator.

ChargeType const& getCharge (  )  const [inline]

Non-mutable access to the charge.

void setCharge ( ChargeType  charge  )  [inline]

Mutable access to the charge.


Member Data Documentation

ChargeType charge_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:49 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1