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

Tagging Class Reference
[Metadata]

#include <OpenMS/METADATA/Tagging.h>

Inheritance diagram for Tagging:

Modification SampleTreatment MetaInfoInterface

List of all members.


Detailed Description

Meta information about tagging of a sample e.g. ICAT labeling.

Holds information about the mass difference between light and heavy tag. All other relevant information is provided by Modification.

Public Types

enum  IsotopeVariant { LIGHT, HEAVY, SIZE_OF_ISOTOPEVARIANT }
 Isotope variants (light and heavy). More...

Public Member Functions

 Tagging ()
 default constructor
 Tagging (const Tagging &)
 copy constructor
virtual ~Tagging ()
 destructor
Taggingoperator= (const Tagging &)
 assignment operator
virtual bool operator== (const SampleTreatment &rhs) const
 Equality operator.
virtual SampleTreatmentclone () const
 clone method. See SampleTreatment
float getMassShift () const
 returns the mass difference between light and heavy variant (default is 0.0)
void setMassShift (float mass_shift)
 sets the mass difference between light and heavy variant
const IsotopeVariantgetVariant () const
 returns the isotope variant of the tag (default is LIGHT)
void setVariant (const IsotopeVariant &variant)
 sets the isotope variant of the tag

Static Public Attributes

static const std::string NamesOfIsotopeVariant [SIZE_OF_ISOTOPEVARIANT]
 Names of isotope variants.

Protected Attributes

float mass_shift_
IsotopeVariant variant_


Member Enumeration Documentation

enum IsotopeVariant

Isotope variants (light and heavy).

Enumerator:
LIGHT 
HEAVY 
SIZE_OF_ISOTOPEVARIANT 


Constructor & Destructor Documentation

Tagging (  ) 

default constructor

Tagging ( const Tagging  ) 

copy constructor

virtual ~Tagging (  )  [virtual]

destructor


Member Function Documentation

Tagging& operator= ( const Tagging  ) 

assignment operator

virtual bool operator== ( const SampleTreatment rhs  )  const [virtual]

Equality operator.

Although this operator takes a reference to a SampleTreatment as argument it tests for the equality of Tagging instances!

Reimplemented from Modification.

virtual SampleTreatment* clone (  )  const [virtual]

clone method. See SampleTreatment

Reimplemented from Modification.

float getMassShift (  )  const

returns the mass difference between light and heavy variant (default is 0.0)

void setMassShift ( float  mass_shift  ) 

sets the mass difference between light and heavy variant

const IsotopeVariant& getVariant (  )  const

returns the isotope variant of the tag (default is LIGHT)

void setVariant ( const IsotopeVariant variant  ) 

sets the isotope variant of the tag


Member Data Documentation

const std::string NamesOfIsotopeVariant[SIZE_OF_ISOTOPEVARIANT] [static]

Names of isotope variants.

float mass_shift_ [protected]

IsotopeVariant variant_ [protected]


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