Meta information about tagging of a sample e.g. ICAT labeling. More...
#include <OpenMS/METADATA/Tagging.h>
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 | |
| Tagging & | operator= (const Tagging &) |
| assignment operator | |
| virtual bool | operator== (const SampleTreatment &rhs) const |
| Equality operator. | |
| virtual SampleTreatment * | clone () const |
| clone method. See SampleTreatment | |
| DoubleReal | getMassShift () const |
| returns the mass difference between light and heavy variant (default is 0.0) | |
| void | setMassShift (DoubleReal 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 | |
Static Public Attributes | |
| static const std::string | NamesOfIsotopeVariant [SIZE_OF_ISOTOPEVARIANT] |
| Names of isotope variants. | |
Protected Attributes | |
| DoubleReal | mass_shift_ |
| IsotopeVariant | variant_ |
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.
Member Enumeration Documentation
| enum IsotopeVariant |
Constructor & Destructor Documentation
| Tagging | ( | ) |
default constructor
| virtual ~Tagging | ( | ) | [virtual] |
destructor
Member Function Documentation
| virtual SampleTreatment* clone | ( | ) | const [virtual] |
clone method. See SampleTreatment
Reimplemented from Modification.
| DoubleReal getMassShift | ( | ) | const |
returns the mass difference between light and heavy variant (default is 0.0)
| const IsotopeVariant& getVariant | ( | ) | const |
returns the isotope variant of the tag (default is LIGHT)
| 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.
| void setMassShift | ( | DoubleReal | mass_shift | ) |
sets the mass difference between light and heavy variant
| void setVariant | ( | const IsotopeVariant & | variant | ) |
sets the isotope variant of the tag
Member Data Documentation
DoubleReal mass_shift_ [protected] |
const std::string NamesOfIsotopeVariant[SIZE_OF_ISOTOPEVARIANT] [static] |
Names of isotope variants.
IsotopeVariant variant_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |