pwiz::msdata::FileDescription Struct Reference

Information pertaining to the entire mzML file (i.e. not specific to any part of the data set) is stored here. More...

#include <MSData.hpp>

List of all members.

Public Member Functions
bool	empty () const
	returns true iff all members are empty or null

Public Attributes
FileContent	fileContent
	this summarizes the different types of spectra that can be expected in the file. This is expected to aid processing software in skipping files that do not contain appropriate spectrum types for it.
std::vector< SourceFilePtr >	sourceFilePtrs
	list and descriptions of the source files this mzML document was generated or derived from.
std::vector< Contact >	contacts
	structure allowing the use of a controlled (cvParam) or uncontrolled vocabulary (userParam), or a reference to a predefined set of these in this mzML file (paramGroupRef)

---

Detailed Description

Information pertaining to the entire mzML file (i.e. not specific to any part of the data set) is stored here.

Definition at line 82 of file MSData.hpp.

---

Member Function Documentation

bool pwiz::msdata::FileDescription::empty

(

)

const

returns true iff all members are empty or null

Referenced by pwiz::msdata::TextWriter::operator()(), and testMSData().

---

Member Data Documentation

FileContent pwiz::msdata::FileDescription::fileContent

this summarizes the different types of spectra that can be expected in the file. This is expected to aid processing software in skipping files that do not contain appropriate spectrum types for it.

Definition at line 85 of file MSData.hpp.

Referenced by initializeTestData(), initializeTinyMGF(), initializeTinyMS1(), initializeTinyMS2(), pwiz::msdata::TextWriter::operator()(), test(), testFileDescription(), and testMSData().

std::vector<SourceFilePtr> pwiz::msdata::FileDescription::sourceFilePtrs

list and descriptions of the source files this mzML document was generated or derived from.

Definition at line 88 of file MSData.hpp.

Referenced by hackInMemoryMSData(), initializeTestData(), initializeTinyMS1(), initializeTinyMS2(), pwiz::msdata::TextWriter::operator()(), test(), testFileDescription(), testRun(), testScanSettings(), testSHA1(), and testSpectrum().

std::vector<Contact> pwiz::msdata::FileDescription::contacts

structure allowing the use of a controlled (cvParam) or uncontrolled vocabulary (userParam), or a reference to a predefined set of these in this mzML file (paramGroupRef)

Definition at line 91 of file MSData.hpp.

Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), and testFileDescription().

---

The documentation for this struct was generated from the following file:

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/MSData.hpp