Description of the default peak processing method. This element describes the base method used in the generation of a particular mzML file. Variable methods should be described in the appropriate acquisition section - if no acquisition-specific details are found, then this information serves as the default. More...
#include <MSData.hpp>
Public Member Functions | |
| ProcessingMethod () | |
| 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 | |
| int | order |
| this attributes allows a series of consecutive steps to be placed in the correct order. | |
| SoftwarePtr | softwarePtr |
| this attribute MUST reference the 'id' of the appropriate SoftwareType. | |
| 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
Description of the default peak processing method. This element describes the base method used in the generation of a particular mzML file. Variable methods should be described in the appropriate acquisition section - if no acquisition-specific details are found, then this information serves as the default.
Definition at line 252 of file MSData.hpp.
Constructor & Destructor Documentation
|
inline |
Definition at line 260 of file MSData.hpp.
Member Function Documentation
| bool pwiz::msdata::ProcessingMethod::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
| int pwiz::msdata::ProcessingMethod::order |
this attributes allows a series of consecutive steps to be placed in the correct order.
Definition at line 255 of file MSData.hpp.
Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), testDataProcessing(), and testProcessingMethod().
| SoftwarePtr pwiz::msdata::ProcessingMethod::softwarePtr |
this attribute MUST reference the 'id' of the appropriate SoftwareType.
Definition at line 258 of file MSData.hpp.
Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), testDataProcessing(), and testProcessingMethod().
The documentation for this struct was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/MSData.hpp
