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

RawDataPoint1D Class Reference
[Kernel]

#include <OpenMS/KERNEL/RawDataPoint1D.h>

Inheritance diagram for RawDataPoint1D:

Peak1D PickedPeak1D

List of all members.


Detailed Description

1-dimensional raw data point.

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

Public Types

Type definitions
enum  { DIMENSION = 1 }
 Dimension. More...
typedef Real IntensityType
 Intensity type.
typedef DPosition< 1 > PositionType
 Position type.
typedef DoubleReal CoordinateType
 Coordinate type.

Public Member Functions

RawDataPoint1Doperator= (const RawDataPoint1D &rhs)
 Assignment operator.
bool operator== (const RawDataPoint1D &rhs) const
 Equality operator.
bool operator!= (const RawDataPoint1D &rhs) const
 Equality operator.
Constructors and Destructor
 RawDataPoint1D ()
 Default constructor.
 RawDataPoint1D (const RawDataPoint1D &p)
 Copy constructor.
 ~RawDataPoint1D ()
 Destructor.
Accessors
IntensityType getIntensity () const
 Non-mutable access to the data point intensity (height).
void setIntensity (IntensityType intensity)
 Mutable access to the data point intensity (height).
CoordinateType getMZ () const
 Non-mutable access to m/z.
void setMZ (CoordinateType mz)
 Mutable access to m/z.
CoordinateType getPos () const
 Alias for getMZ().
void setPos (CoordinateType pos)
 Alias for setMZ().
PositionType const & getPosition () const
 Non-mutable access to the position.
PositionTypegetPosition ()
 Mutable access to the position.
void setPosition (PositionType const &position)
 Mutable access to the position.

Protected Attributes

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

Classes

struct  IntensityLess
 Compare by getIntensity(). More...
struct  PositionLess
 Comparator for the position. More...


Member Typedef Documentation

typedef Real IntensityType

Intensity type.

typedef DPosition<1> PositionType

Position type.

typedef DoubleReal CoordinateType

Coordinate type.


Member Enumeration Documentation

anonymous enum

Dimension.

Enumerator:
DIMENSION 


Constructor & Destructor Documentation

RawDataPoint1D (  )  [inline]

Default constructor.

RawDataPoint1D ( const RawDataPoint1D p  )  [inline]

Copy constructor.

~RawDataPoint1D (  )  [inline]

Destructor.

Note:
The destructor is non-virtual although many classes are derived from RawDataPoint1D. This is intentional, since otherwise we would "waste" space for a vtable pointer in each instance - but RawDataPoint1Ds are used in great amounts for storing raw data. Normally you should not derive other classes from RawDataPoint1D (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]

Mutable access to the data point intensity (height).

CoordinateType getMZ (  )  const [inline]

Non-mutable access to m/z.

void setMZ ( CoordinateType  mz  )  [inline]

Mutable access to m/z.

CoordinateType getPos (  )  const [inline]

Alias for getMZ().

void setPos ( CoordinateType  pos  )  [inline]

Alias for setMZ().

PositionType const& getPosition (  )  const [inline]

Non-mutable access to the position.

PositionType& getPosition (  )  [inline]

Mutable access to the position.

void setPosition ( PositionType const &  position  )  [inline]

Mutable access to the position.

RawDataPoint1D& operator= ( const RawDataPoint1D rhs  )  [inline]

Assignment operator.

bool operator== ( const RawDataPoint1D rhs  )  const [inline]

Equality operator.

bool operator!= ( const RawDataPoint1D 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:46 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1