MassDecomposition Class Reference

Class represents a decomposition of a mass into amino acids. More...

#include <OpenMS/CHEMISTRY/MASSDECOMPOSITION/MassDecomposition.h>

List of all members.

Public Member Functions
Constructors and destructors
	MassDecomposition ()
	default constructor
	MassDecomposition (const MassDecomposition &deco)
	copy constructor
	MassDecomposition (const String &deco)
	constructor with String as parameter
Operators and accessors
MassDecomposition &	operator= (const MassDecomposition &rhs)
	assignment operator
MassDecomposition &	operator+= (const MassDecomposition &d)
	adds the mass decomposition d to this object
String	toString () const
	returns the decomposition as a string
String	toExpandedString () const
	returns the decomposition as a string; instead of frequencies the amino acids are repeated
MassDecomposition	operator+ (const MassDecomposition &rhs) const
	adds this decomposition and the decomposition given and returns a new composition
Size	getNumberOfMaxAA () const
	returns the max frequency of this composition
Predicates
bool	operator< (const MassDecomposition &rhs) const
	less than predicate
bool	operator== (const String &deco) const
	equality operator
bool	containsTag (const String &tag) const
	returns true if tag is contained in the mass decomposition
bool	compatible (const MassDecomposition &deco) const
	returns true if the mass decomposition if contained in this instance
Protected Attributes
Map< char, Size >	decomp_
Size	number_of_max_aa_

---

Detailed Description

Class represents a decomposition of a mass into amino acids.

This class represents a mass decomposition into amino acids. A decomposition are amino acids given with frequencies which add up to a specific mass.

---

Constructor & Destructor Documentation

MassDecomposition

(

)

default constructor

MassDecomposition

(

const MassDecomposition &

deco

)

copy constructor

MassDecomposition

(

const String &

deco

)

[explicit]

constructor with String as parameter

---

Member Function Documentation

bool compatible

(

const MassDecomposition &

deco

)

const

returns true if the mass decomposition if contained in this instance

bool containsTag

(

const String &

tag

)

const

returns true if tag is contained in the mass decomposition

Size getNumberOfMaxAA

(

)

const

returns the max frequency of this composition

MassDecomposition operator+

(

const MassDecomposition &

rhs

)

const

adds this decomposition and the decomposition given and returns a new composition

MassDecomposition& operator+=

(

const MassDecomposition &

d

)

adds the mass decomposition d to this object

bool operator<

(

const MassDecomposition &

rhs

)

const

less than predicate

MassDecomposition& operator=

(

const MassDecomposition &

rhs

)

assignment operator

bool operator==

(

const String &

deco

)

const

equality operator

String toExpandedString

(

)

const

returns the decomposition as a string; instead of frequencies the amino acids are repeated

String toString

(

)

const

returns the decomposition as a string

---

Member Data Documentation

Map<char, Size> decomp_ [protected]

Size number_of_max_aa_ [protected]