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

Precursor Class Reference
[Metadata]

#include <OpenMS/METADATA/Precursor.h>

Inheritance diagram for Precursor:

MetaInfoInterface

List of all members.


Detailed Description

Precursor meta information.

This class stores precursor meta information, that is not already covered by DSpectrum::getPrecursorPeak().

Public Types

enum  ActivationMethod {
  ACTMETHNULL, CID, PSD, PD,
  SID, SIZE_OF_ACTIVATIONMETHOD
}
 Method of activation. More...
enum  EnergyUnits { UNITSNULL, EV, PERCENT, SIZE_OF_ENERGYUNITS }
 Energy unit. More...

Public Member Functions

 Precursor ()
 Constructor.
 Precursor (const Precursor &source)
 Copy constructor.
 ~Precursor ()
 Destructor.
Precursoroperator= (const Precursor &source)
 Assignment operator.
bool operator== (const Precursor &rhs) const
 Equality operator.
bool operator!= (const Precursor &rhs) const
 Equality operator.
ActivationMethod getActivationMethod () const
 returns the activation method
void setActivationMethod (ActivationMethod activation_method)
 sets the activation method
float getActivationEnergy () const
 returns the activation energy
void setActivationEnergy (float activation_energy)
 sets the activation energy
EnergyUnits getActivationEnergyUnit () const
 return the actication energy unit
void setActivationEnergyUnit (EnergyUnits activation_energy_unit)
 sets the activation energy unit
float getWindowSize () const
 returns the window size
void setWindowSize (float size)
 sets the window size

Static Public Attributes

static const std::string NamesOfActivationMethod [SIZE_OF_ACTIVATIONMETHOD]
 Names of activation methods.
static const std::string NamesOfEnergyUnits [SIZE_OF_ENERGYUNITS]
 Names of energy units.

Protected Attributes

ActivationMethod activation_method_
float activation_energy_
EnergyUnits activation_energy_unit_
float window_size_


Member Enumeration Documentation

enum ActivationMethod

Method of activation.

Enumerator:
ACTMETHNULL 
CID 
PSD 
PD 
SID 
SIZE_OF_ACTIVATIONMETHOD 

enum EnergyUnits

Energy unit.

Enumerator:
UNITSNULL 
EV 
PERCENT 
SIZE_OF_ENERGYUNITS 


Constructor & Destructor Documentation

Precursor (  ) 

Constructor.

Precursor ( const Precursor source  ) 

Copy constructor.

~Precursor (  ) 

Destructor.


Member Function Documentation

Precursor& operator= ( const Precursor source  ) 

Assignment operator.

bool operator== ( const Precursor rhs  )  const

Equality operator.

bool operator!= ( const Precursor rhs  )  const

Equality operator.

ActivationMethod getActivationMethod (  )  const

returns the activation method

void setActivationMethod ( ActivationMethod  activation_method  ) 

sets the activation method

float getActivationEnergy (  )  const

returns the activation energy

void setActivationEnergy ( float  activation_energy  ) 

sets the activation energy

EnergyUnits getActivationEnergyUnit (  )  const

return the actication energy unit

void setActivationEnergyUnit ( EnergyUnits  activation_energy_unit  ) 

sets the activation energy unit

float getWindowSize (  )  const

returns the window size

void setWindowSize ( float  size  ) 

sets the window size


Member Data Documentation

const std::string NamesOfActivationMethod[SIZE_OF_ACTIVATIONMETHOD] [static]

Names of activation methods.

const std::string NamesOfEnergyUnits[SIZE_OF_ENERGYUNITS] [static]

Names of energy units.

ActivationMethod activation_method_ [protected]

float activation_energy_ [protected]

EnergyUnits activation_energy_unit_ [protected]

float window_size_ [protected]


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