Meta information about chemical modification of a sample. More...
#include <OpenMS/METADATA/Modification.h>
Public Types | |
| enum | SpecificityType { AA, AA_AT_CTERM, AA_AT_NTERM, CTERM, NTERM, SIZE_OF_SPECIFICITYTYPE } |
specificity of the reagent. More... | |
Public Member Functions | |
| Modification () | |
| default constructor | |
| Modification (const Modification &) | |
| copy constructor | |
| virtual | ~Modification () |
| destructor | |
| Modification & | operator= (const Modification &) |
| assignment operator | |
| virtual bool | operator== (const SampleTreatment &rhs) const |
| Equality operator. | |
| virtual SampleTreatment * | clone () const |
| clone method. See SampleTreatment | |
| const String & | getReagentName () const |
| returns the name of the reagent that was used (default: "") | |
| void | setReagentName (const String &reagent_name) |
| sets the name of the reagent that was used | |
| DoubleReal | getMass () const |
| returns the mass change (default: 0.0) | |
| void | setMass (DoubleReal mass) |
| sets the mass change | |
| const SpecificityType & | getSpecificityType () const |
| returns the specificity of the the reagent (default: AA) | |
| void | setSpecificityType (const SpecificityType &specificity_type) |
| sets the specificity of the the reagent | |
| const String & | getAffectedAminoAcids () const |
| returns a string containing the one letter code of the amino acids that are affected by the reagent. (default: "") | |
| void | setAffectedAminoAcids (const String &affected_amino_acids) |
| returns a string containing the one letter code of the amino acids that are affected by the reagent. Do not separate them by space, tab or comma! | |
Static Public Attributes | |
| static const std::string | NamesOfSpecificityType [SIZE_OF_SPECIFICITYTYPE] |
| Names of specifitiy types. | |
Protected Attributes | |
| String | reagent_name_ |
| DoubleReal | mass_ |
| SpecificityType | specificity_type_ |
| String | affected_amino_acids_ |
Detailed Description
Meta information about chemical modification of a sample.
Representation of some kind of modification. It hold information about what amino acids are modified and how much the mass changes.
Member Enumeration Documentation
| enum SpecificityType |
specificity of the reagent.
Constructor & Destructor Documentation
| Modification | ( | ) |
default constructor
| Modification | ( | const Modification & | ) |
copy constructor
| virtual ~Modification | ( | ) | [virtual] |
destructor
Member Function Documentation
| virtual SampleTreatment* clone | ( | ) | const [virtual] |
| const String& getAffectedAminoAcids | ( | ) | const |
returns a string containing the one letter code of the amino acids that are affected by the reagent. (default: "")
| DoubleReal getMass | ( | ) | const |
returns the mass change (default: 0.0)
| const String& getReagentName | ( | ) | const |
returns the name of the reagent that was used (default: "")
| const SpecificityType& getSpecificityType | ( | ) | const |
returns the specificity of the the reagent (default: AA)
| Modification& operator= | ( | const Modification & | ) |
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 SampleTreatment.
Reimplemented in Tagging.
| void setAffectedAminoAcids | ( | const String & | affected_amino_acids | ) |
returns a string containing the one letter code of the amino acids that are affected by the reagent. Do not separate them by space, tab or comma!
| void setMass | ( | DoubleReal | mass | ) |
sets the mass change
| void setReagentName | ( | const String & | reagent_name | ) |
sets the name of the reagent that was used
| void setSpecificityType | ( | const SpecificityType & | specificity_type | ) |
sets the specificity of the the reagent
Member Data Documentation
String affected_amino_acids_ [protected] |
DoubleReal mass_ [protected] |
const std::string NamesOfSpecificityType[SIZE_OF_SPECIFICITYTYPE] [static] |
Names of specifitiy types.
String reagent_name_ [protected] |
SpecificityType specificity_type_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |