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

DRawDataPoint Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/DRawDataPoint.h>

Inheritance diagram for DRawDataPoint:

DPeak PrecursorPeak

List of all members.


Detailed Description

template<UInt D>
class OpenMS::DRawDataPoint< D >

D-dimensional raw data point.

This datastructure is intended for continous data. If you want to handle picked data use DPeak or PickedPeak1D.

Public Types

Type definitions
enum  { DIMENSION = D }
 Dimensionality. More...
typedef Real IntensityType
 Intensity type.
typedef DoubleReal CoordinateType
 Coordinate type (of the position).
typedef DPosition< D > PositionType
 Position type.

Public Member Functions

DRawDataPointoperator= (const DRawDataPoint &rhs)
 Assignment operator.
bool operator== (const DRawDataPoint &rhs) const
 Equality operator.
bool operator!= (const DRawDataPoint &rhs) const
 Equality operator.
Constructors and Destructor
 DRawDataPoint ()
 Default constructor.
 DRawDataPoint (const DRawDataPoint &p)
 Copy constructor.
 ~DRawDataPoint ()
 Destructor.
Accessors
IntensityType getIntensity () const
 Non-mutable access to the data point intensity (height).
void setIntensity (IntensityType intensity)
 Non-mutable access to the data point intensity (height).
const PositionTypegetPosition () const
 Non-mutable access to the data point position (multidimensional).
PositionTypegetPosition ()
 Mutable access to the data point position (multidimensional).
void setPosition (PositionType const &position)
 Mutable access to the data point position (multidimensional).

Protected Attributes

PositionType position_
 The data point position.
IntensityType intensity_
 The data point intensity.

Classes

struct  IntensityLess
 Compare by getIntensity(). More...
struct  NthPositionLess
 Comparator for the i-th coordinate of the position. More...
struct  PositionLess
 Comparator for the position. More...


Member Typedef Documentation

typedef Real IntensityType

Intensity type.

Reimplemented in DPeak.

typedef DoubleReal CoordinateType

Coordinate type (of the position).

Reimplemented in DPeak.

typedef DPosition<D> PositionType

Position type.

Reimplemented in DPeak.


Member Enumeration Documentation

anonymous enum

Dimensionality.

Enumerator:
DIMENSION 


Constructor & Destructor Documentation

DRawDataPoint (  )  [inline]

Default constructor.

DRawDataPoint ( const DRawDataPoint< D > &  p  )  [inline]

Copy constructor.

~DRawDataPoint (  )  [inline]

Destructor.

Note:
The destructor is non-virtual although many classes are derived from DRawDataPoint. This is intentional, since otherwise we would "waste" space for a vtable pointer in each instance - but DRawDataPoints are used in great amounts for storing raw data. Normally you should not derive other classes from DRawDataPoint (unless you know what you are doing, of course).


Member Function Documentation

IntensityType getIntensity (  )  const [inline]

Non-mutable access to the data point intensity (height).

void setIntensity ( IntensityType  intensity  )  [inline]

Non-mutable access to the data point intensity (height).

const PositionType& getPosition (  )  const [inline]

Non-mutable access to the data point position (multidimensional).

PositionType& getPosition (  )  [inline]

Mutable access to the data point position (multidimensional).

void setPosition ( PositionType const &  position  )  [inline]

Mutable access to the data point position (multidimensional).

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

Assignment operator.

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

Equality operator.

bool operator!= ( const DRawDataPoint< D > &  rhs  )  const [inline]

Equality operator.


Member Data Documentation

PositionType position_ [protected]

The data point position.

IntensityType intensity_ [protected]

The data point intensity.


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