ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::ProcessingMethod Struct Reference

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>

Inheritance diagram for pwiz::msdata::ProcessingMethod:
pwiz::data::ParamContainer

Public Member Functions

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

Public Attributes

int order
 this attributes allows a series of consecutive steps to be placed in the correct order. More...
 
SoftwarePtr softwarePtr
 this attribute MUST reference the 'id' of the appropriate SoftwareType. More...
 
- Public Attributes inherited from pwiz::data::ParamContainer
std::vector< ParamGroupPtrparamGroupPtrs
 a collection of references to ParamGroups More...
 
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms More...
 
std::vector< UserParamuserParams
 a collection of uncontrolled user terms More...
 

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 253 of file MSData.hpp.

Constructor & Destructor Documentation

§ ProcessingMethod()

pwiz::msdata::ProcessingMethod::ProcessingMethod ( )
inline

Definition at line 261 of file MSData.hpp.

261 : order(0) {}
int order
this attributes allows a series of consecutive steps to be placed in the correct order.
Definition: MSData.hpp:256

Member Function Documentation

§ empty()

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

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

Member Data Documentation

§ order

int pwiz::msdata::ProcessingMethod::order

this attributes allows a series of consecutive steps to be placed in the correct order.

Definition at line 256 of file MSData.hpp.

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

§ softwarePtr

SoftwarePtr pwiz::msdata::ProcessingMethod::softwarePtr

this attribute MUST reference the 'id' of the appropriate SoftwareType.

Definition at line 259 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: