MassDecomposition Class Reference

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

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

Collaboration diagram for MassDecomposition:

Public Member Functions
Constructors and destructors
	MassDecomposition ()
	default constructor More...
	MassDecomposition (const MassDecomposition &deco)
	copy constructor More...
	MassDecomposition (const String &deco)
	constructor with String as parameter More...
Operators and accessors
MassDecomposition &	operator= (const MassDecomposition &rhs)
	assignment operator More...
MassDecomposition &	operator+= (const MassDecomposition &d)
	adds the mass decomposition d to this object More...
String	toString () const
	returns the decomposition as a string More...
String	toExpandedString () const
	returns the decomposition as a string; instead of frequencies the amino acids are repeated More...
MassDecomposition	operator+ (const MassDecomposition &rhs) const
	adds this decomposition and the decomposition given and returns a new composition More...
Size	getNumberOfMaxAA () const
	returns the max frequency of this composition More...

Predicates
std::map< char, Size >	decomp_
Size	number_of_max_aa_
bool	operator< (const MassDecomposition &rhs) const
	less than predicate More...
bool	operator== (const String &deco) const
	equality operator More...
bool	containsTag (const String &tag) const
	returns true if tag is contained in the mass decomposition More...
bool	compatible (const MassDecomposition &deco) const
	returns true if the mass decomposition if contained in this instance More...

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() [1/3]

MassDecomposition

(

)

default constructor

MassDecomposition() [2/3]

MassDecomposition

(

const MassDecomposition &

deco

)

copy constructor

MassDecomposition() [3/3]

MassDecomposition ( const String &  deco )

explicit

constructor with String as parameter

Member Function Documentation

compatible()

bool compatible

(

const MassDecomposition &

deco

)

const

returns true if the mass decomposition if contained in this instance

containsTag()

bool containsTag

(

const String &

tag

)

const

returns true if tag is contained in the mass decomposition

getNumberOfMaxAA()

Size getNumberOfMaxAA

(

)

const

returns the max frequency of this composition

operator+()

MassDecomposition operator+

(

const MassDecomposition &

rhs

)

const

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

operator+=()

MassDecomposition& operator+=

(

const MassDecomposition &

d

)

adds the mass decomposition d to this object

operator<()

bool operator<

(

const MassDecomposition &

rhs

)

const

less than predicate

operator=()

MassDecomposition& operator=

(

const MassDecomposition &

rhs

)

assignment operator

operator==()

bool operator==

(

const String &

deco

)

const

equality operator

toExpandedString()

String toExpandedString

(

)

const

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

toString()

String toString

(

)

const

returns the decomposition as a string

Member Data Documentation

decomp_

std::map<char, Size> decomp_

protected

number_of_max_aa_

Size number_of_max_aa_

protected