mgf Namespace Reference

The library namespace that holds all library-specific types, classes and functions. More...

Classes
class	Parser
	A Bison parser. More...
class	Scanner
	Scanner is a derived class to add some extra function to the scanner class. More...
class	Collection
	A std::vector<T> composite. More...
struct	Context
	Context used to save the parsed expressions. More...
class	Driver
	The primary user interface class. More...
struct	LessThanMz
	Functor for m/z-based comparison of MassAbundancePairs. More...
struct	LessThanAbundance
	Functor for abundance-based comparison of MassAbundancePairs. More...
class	MgfFile
	A Mascot Generic Format file type. More...
class	MgfHeader
	Mascot Generic Format file header (global parameters) information. More...
class	MgfSpectrum
	An MgfSpectrum holds a fragment ion series and the corresponding (local) search parameters. More...
Typedefs
typedef std::pair< double, double >	MassAbundancePair
	A type for representing a fragment ion m/z and abundance.
Functions
std::ostream &	operator<< (std::ostream &os, const MgfFile &mgf)
	A stream operator to output the contents of an MgfFile object as valid MGF.
std::ostream &	operator<< (std::ostream &os, const MgfHeader &mgf)
	A stream operator to output the header information in MGF.
std::ostream &	operator<< (std::ostream &os, const MgfSpectrum &mgf)
	An stream operator to output the fragment ion spectrum in MGF.
template<class T , class A >
bool	operator== (const Collection< T, A > &lhs, const Collection< T, A > &rhs)
template<class T , class A >
bool	operator< (const Collection< T, A > &lhs, const Collection< T, A > &rhs)
template<class T , class A >
void	swap (Collection< T, A > &lhs, Collection< T, A > &rhs)
template<class T >
T::mapped_type	existsOrEmpty (T map, typename T::key_type key)
	Helper function to check if a value exists in a map.
Variables
class MGFP_EXPORT	Scanner

---

Detailed Description

The library namespace that holds all library-specific types, classes and functions.

---

Typedef Documentation

typedef std::pair<double, double> mgf::MassAbundancePair

A type for representing a fragment ion m/z and abundance.

---

Function Documentation

template<class T >

T::mapped_type mgf::existsOrEmpty	(	T	map,
		typename T::key_type	key
	)			[inline]

Helper function to check if a value exists in a map.

This is necessary because std::map<A,B>::operator[] creates and returns an empty object if the specified key dows not exist.

std::ostream & mgf::operator<<	(	std::ostream &	os,
		const MgfSpectrum &	mgf
	)

An stream operator to output the fragment ion spectrum in MGF.

This includes all entries between BEGIN IONS and END IONS as well as all local parameter key/value-pairs.

std::ostream & mgf::operator<<	(	std::ostream &	os,
		const MgfHeader &	mgf
	)

A stream operator to output the header information in MGF.

std::ostream & mgf::operator<<	(	std::ostream &	os,
		const MgfFile &	mgf
	)

A stream operator to output the contents of an MgfFile object as valid MGF.