mgf::MgfFile Class Reference

A Mascot Generic Format file type. More...

#include <MgfFile.h>

Inheritance diagram for mgf::MgfFile:

List of all members.

Public Member Functions
	MgfFile ()
	Default constructor.
void	getHeader (MgfHeader &header)
	Returns the file header information.
MgfHeader &	getHeaderRef ()
	Returns a reference to the file header information.
void	setHeader (const MgfHeader &header)
	Set the MGF file header information.
void	clear ()
	Clear all data from the current MgfFile object.
Friends
std::ostream &	operator<< (std::ostream &os, const MgfFile &mgf)

---

Detailed Description

A Mascot Generic Format file type.

An MgfFile is essentially a container for a set of global settings (i.e. an HgfHeader) and a set of fragment ion spectra, each of which is represented using an MgfSpectrum.

---

Constructor & Destructor Documentation

mgf::MgfFile::MgfFile

(

)

Default constructor.

Creates an empty MgfFile object.

---

Member Function Documentation

void mgf::MgfFile::clear

(

)

[virtual]

Clear all data from the current MgfFile object.

Reimplemented from mgf::Collection< MgfSpectrum >.

void mgf::MgfFile::getHeader

(

MgfHeader &

header

)

Returns the file header information.

Parameters:

[out]

header

mgf::MgfHeader object.

MgfHeader & mgf::MgfFile::getHeaderRef

(

)

Returns a reference to the file header information.

Returns:

Returns a non-const reference to the mgf::MgfHeader object.

void mgf::MgfFile::setHeader

(

const MgfHeader &

header

)

Set the MGF file header information.

Parameters:

[in]

header

mgf::MgfHeader object.

---

The documentation for this class was generated from the following files:

• include/mgfp/MgfFile.h
• src/MgfFile.cpp