Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Protected Attributes | List of all members
ModificationDefinition Class Reference

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
ModificationDefinitionoperator= (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 ResidueModificationmod_
 the modification More...
 
bool fixed_modification_
 fixed (true) or variable (false) More...
 
UInt max_occurences_
 maximal number of occurences per peptide More...
 

Detailed Description

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.

Constructor & Destructor Documentation

default constructor

copy constructor

ModificationDefinition ( const String mod)
explicit

detailed constructor specifying the modifications name

virtual ~ModificationDefinition ( )
virtual

destructor

Member Function Documentation

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

Member Data Documentation

bool fixed_modification_
protected

fixed (true) or variable (false)

UInt max_occurences_
protected

maximal number of occurences per peptide

const ResidueModification* mod_
protected

the modification

allowed position


OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:28 using doxygen 1.8.11