The method of precursor ion selection and activation. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::Precursor:

Public Member Functions
	Precursor ()
	Precursor (double mz)
	Precursor (double mz, double intensity, CVID intensityUnit)
	Precursor (double mz, int chargeState)
	Precursor (double mz, double intensity, int chargeState, CVID intensityUnit)
bool	empty () const
	returns true iff the element contains no params and all members are empty or null
Public Member Functions inherited from pwiz::data::ParamContainer
CVParam	cvParam (CVID cvid) const
	finds cvid in the container:
CVParam	cvParamChild (CVID cvid) const
	finds child of cvid in the container:
std::vector< CVParam >	cvParamChildren (CVID cvid) const
	finds all children of cvid in the container:
bool	hasCVParam (CVID cvid) const
	returns true iff cvParams contains exact cvid (recursive)
bool	hasCVParamChild (CVID cvid) const
	returns true iff cvParams contains a child (is_a) of cvid (recursive)
UserParam	userParam (const std::string &) const
	finds UserParam with specified name
void	set (CVID cvid, const std::string &value="", CVID units=CVID_Unknown)
	set/add a CVParam (not recursive)
void	set (CVID cvid, double value, CVID units=CVID_Unknown)
	set/add a CVParam (not recursive)
void	set (CVID cvid, int value, CVID units=CVID_Unknown)
	set/add a CVParam (not recursive)
template<typename value_type >
void	set (CVID cvid, value_type value, CVID units=CVID_Unknown)
	set/add a CVParam (not recursive)
void	clear ()
	clears the collections
bool	operator== (const ParamContainer &that) const
	returns true iff this and that have the exact same cvParams and userParams
bool	operator!= (const ParamContainer &that) const
	returns !(this==that)
template<>
void	set (CVID cvid, bool value, CVID units)
	special case for bool (outside the class for gcc 3.4, and inline for msvc)

Public Attributes
SourceFilePtr	sourceFilePtr
	for precursor spectra that are external to this document, this attribute MUST reference the 'id' attribute of a sourceFile representing that external document.
std::string	externalSpectrumID
	for precursor spectra that are external to this document, this string MUST correspond to the 'id' attribute of a spectrum in the external document indicated by 'sourceFileRef'.
std::string	spectrumID
	reference to the id attribute of the spectrum from which the precursor was selected.
IsolationWindow	isolationWindow
	this element captures the isolation (or 'selection') window configured to isolate one or more precursors.
std::vector< SelectedIon >	selectedIons
	this list of precursor ions that were selected.
Activation	activation
	the type and energy level used for activation.
Public Attributes inherited from pwiz::data::ParamContainer
std::vector< ParamGroupPtr >	paramGroupPtrs
	a collection of references to ParamGroups
std::vector< CVParam >	cvParams
	a collection of controlled vocabulary terms
std::vector< UserParam >	userParams
	a collection of uncontrolled user terms

Detailed Description

The method of precursor ion selection and activation.

Definition at line 309 of file MSData.hpp.

Constructor & Destructor Documentation

pwiz::msdata::Precursor::Precursor ( )

inline

Definition at line 332 of file MSData.hpp.

{}

pwiz::msdata::Precursor::Precursor ( double mz )

explicit

pwiz::msdata::Precursor::Precursor	(	double	mz,
		double	intensity,
		CVID	intensityUnit
	)

explicit

pwiz::msdata::Precursor::Precursor	(	double	mz,
		int	chargeState
	)

explicit

pwiz::msdata::Precursor::Precursor	(	double	mz,
		double	intensity,
		int	chargeState,
		CVID	intensityUnit
	)

explicit

Member Function Documentation

bool pwiz::msdata::Precursor::empty ( ) const

returns true iff the element contains no params and all members are empty or null

Reimplemented from pwiz::data::ParamContainer.

Member Data Documentation

SourceFilePtr pwiz::msdata::Precursor::sourceFilePtr

for precursor spectra that are external to this document, this attribute MUST reference the 'id' attribute of a sourceFile representing that external document.

note: this attribute is mutually exclusive with spectrumID; i.e. use one or the other but not both

Definition at line 313 of file MSData.hpp.

std::string pwiz::msdata::Precursor::externalSpectrumID

for precursor spectra that are external to this document, this string MUST correspond to the 'id' attribute of a spectrum in the external document indicated by 'sourceFileRef'.

note: this attribute is mutually exclusive with spectrumID; i.e. use one or the other but not both

Definition at line 317 of file MSData.hpp.

std::string pwiz::msdata::Precursor::spectrumID

reference to the id attribute of the spectrum from which the precursor was selected.

note: this attribute is mutually exclusive with externalSpectrumID; i.e. use one or the other but not both

Definition at line 321 of file MSData.hpp.

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

IsolationWindow pwiz::msdata::Precursor::isolationWindow

this element captures the isolation (or 'selection') window configured to isolate one or more precursors.

Definition at line 324 of file MSData.hpp.

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

std::vector<SelectedIon> pwiz::msdata::Precursor::selectedIons