Scan or acquisition from original raw file used to create this peak list, as specified in sourceFile. More...
#include <MSData.hpp>
Public Member Functions | |
| 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 |
| if this attribute is set, it must reference the 'id' attribute of a sourceFile representing the external document containing the spectrum referred to by 'externalSpectrumID'. | |
| std::string | externalSpectrumID |
| for scans 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 |
| for scans that are local to this document, this attribute can be used to reference the 'id' attribute of the spectrum corresponding to the scan. | |
| InstrumentConfigurationPtr | instrumentConfigurationPtr |
| this attribute MUST reference the 'id' attribute of the appropriate instrument configuration. | |
| std::vector< ScanWindow > | scanWindows |
| container for a list of select windows. | |
| 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
Scan or acquisition from original raw file used to create this peak list, as specified in sourceFile.
Definition at line 367 of file MSData.hpp.
Member Function Documentation
| bool pwiz::msdata::Scan::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::Scan::sourceFilePtr |
if this attribute is set, it must reference the 'id' attribute of a sourceFile representing the external document containing the spectrum referred to by 'externalSpectrumID'.
note: this attribute is mutually exclusive with spectrumID; i.e. use one or the other but not both
Definition at line 371 of file MSData.hpp.
| std::string pwiz::msdata::Scan::externalSpectrumID |
for scans 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 375 of file MSData.hpp.
| std::string pwiz::msdata::Scan::spectrumID |
for scans that are local to this document, this attribute can be used to reference the 'id' attribute of the spectrum corresponding to the scan.
note: this attribute is mutually exclusive with externalSpectrumID; i.e. use one or the other but not both
Definition at line 379 of file MSData.hpp.
| InstrumentConfigurationPtr pwiz::msdata::Scan::instrumentConfigurationPtr |
this attribute MUST reference the 'id' attribute of the appropriate instrument configuration.
Definition at line 382 of file MSData.hpp.
Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), test(), and testScan().
| std::vector<ScanWindow> pwiz::msdata::Scan::scanWindows |
container for a list of select windows.
Definition at line 385 of file MSData.hpp.
Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), and testScan().
The documentation for this struct was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/MSData.hpp
