Representation of modification definition. More...
#include <OpenMS/CHEMISTRY/ModificationDefinition.h>
Public Member Functions | |
Constructor and Destructors | |
ModificationDefinition () | |
default constructor More... | |
ModificationDefinition (const ModificationDefinition &rhs) | |
copy constructor More... | |
ModificationDefinition (const String &mod) | |
detailed constructor specifying the modifications name More... | |
virtual | ~ModificationDefinition () |
destructor More... | |
Accessors | |
void | setTermSpecificity (ResidueModification::Term_Specificity pos) |
sets the allowed position of the modification More... | |
ResidueModification::Term_Specificity | getTermSpecificity () const |
returns the allowed position of the modification More... | |
void | setFixedModification (bool fixed) |
sets whether this modification definition is fixed or variable (modification must occur vs. can occur) More... | |
bool | isFixedModification () const |
returns if the modification if fixed true, else false More... | |
void | setMaxOccurences (UInt num) |
set the maximal number of occurences per peptide, unbound if 0 More... | |
UInt | getMaxOccurences () const |
returns the maximal number of occurences per peptide More... | |
String | getModification () const |
returns the modification set More... | |
void | setModification (const String &modification) |
sets the modification, allowed are unique names provided by ModificationsDB More... | |
Assignment | |
ModificationDefinition & | operator= (const ModificationDefinition &element) |
assignment operator More... | |
Predicates | |
bool | operator== (const ModificationDefinition &rhs) const |
equality operator More... | |
bool | operator!= (const ModificationDefinition &rhs) const |
inequality operator More... | |
bool | operator< (const OpenMS::ModificationDefinition &) const |
less than operator for e.g. usage in maps; only mod FullIds are compared! More... | |
Protected Attributes | |
ResidueModification::Term_Specificity | term_spec_ |
allowed position More... | |
const ResidueModification * | mod_ |
the modification More... | |
bool | fixed_modification_ |
fixed (true) or variable (false) More... | |
UInt | max_occurences_ |
maximal number of occurences per peptide More... | |
Representation of modification definition.
This class defines a modification type e.g. a input parameter of a search engine. The modification is defined using an unique name of the modification present in the modifications DB instance.
default constructor
ModificationDefinition | ( | const ModificationDefinition & | rhs | ) |
copy constructor
|
explicit |
detailed constructor specifying the modifications name
|
virtual |
destructor
UInt getMaxOccurences | ( | ) | const |
returns the maximal number of occurences per peptide
String getModification | ( | ) | const |
returns the modification set
ResidueModification::Term_Specificity getTermSpecificity | ( | ) | const |
returns the allowed position of the modification
bool isFixedModification | ( | ) | const |
returns if the modification if fixed true, else false
bool operator!= | ( | const ModificationDefinition & | rhs | ) | const |
inequality operator
bool operator< | ( | const OpenMS::ModificationDefinition & | ) | const |
less than operator for e.g. usage in maps; only mod FullIds are compared!
ModificationDefinition& operator= | ( | const ModificationDefinition & | element | ) |
assignment operator
bool operator== | ( | const ModificationDefinition & | rhs | ) | const |
equality operator
void setFixedModification | ( | bool | fixed | ) |
sets whether this modification definition is fixed or variable (modification must occur vs. can occur)
void setMaxOccurences | ( | UInt | num | ) |
set the maximal number of occurences per peptide, unbound if 0
void setModification | ( | const String & | modification | ) |
sets the modification, allowed are unique names provided by ModificationsDB
void setTermSpecificity | ( | ResidueModification::Term_Specificity | pos | ) |
sets the allowed position of the modification
|
protected |
fixed (true) or variable (false)
|
protected |
maximal number of occurences per peptide
|
protected |
the modification
|
protected |
allowed position
OpenMS / TOPP release 2.0.0 | Documentation generated on Tue Aug 25 2015 05:54:03 using doxygen 1.8.9.1 |