ProteoWizard
Public Member Functions | Public Attributes
pwiz::msdata::InstrumentConfiguration Struct Reference

Description of a particular hardware configuration of a mass spectrometer. Each configuration MUST have one (and only one) of the three different components used for an analysis. For hybrid instruments, such as an LTQ-FT, there MUST be one configuration for each permutation of the components that is used in the document. For software configuration, reference the appropriate ScanSettings element. More...

#include <MSData.hpp>

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

List of all members.

Public Member Functions

 InstrumentConfiguration (const std::string &_id="")
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< CVParamcvParamChildren (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

std::string id
 an identifier for this instrument configuration.
ComponentList componentList
 list with the different components used in the mass spectrometer. At least one source, one mass analyzer and one detector need to be specified.
SoftwarePtr softwarePtr
 reference to a previously defined software element.
ScanSettingsPtr scanSettingsPtr
 reference to a scan settings element defining global scan settings used by this configuration
- Public Attributes inherited from pwiz::data::ParamContainer
std::vector< ParamGroupPtrparamGroupPtrs
 a collection of references to ParamGroups
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms
std::vector< UserParamuserParams
 a collection of uncontrolled user terms

Detailed Description

Description of a particular hardware configuration of a mass spectrometer. Each configuration MUST have one (and only one) of the three different components used for an analysis. For hybrid instruments, such as an LTQ-FT, there MUST be one configuration for each permutation of the components that is used in the document. For software configuration, reference the appropriate ScanSettings element.

Definition at line 227 of file MSData.hpp.


Constructor & Destructor Documentation

pwiz::msdata::InstrumentConfiguration::InstrumentConfiguration ( const std::string &  _id = "")

Member Function Documentation

bool pwiz::msdata::InstrumentConfiguration::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

std::string pwiz::msdata::InstrumentConfiguration::id

an identifier for this instrument configuration.

Definition at line 230 of file MSData.hpp.

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

ComponentList pwiz::msdata::InstrumentConfiguration::componentList

list with the different components used in the mass spectrometer. At least one source, one mass analyzer and one detector need to be specified.

Definition at line 233 of file MSData.hpp.

Referenced by pwiz::msdata::TextWriter::operator()(), testAnalyzer(), testDetector(), testInstrumentConfiguration(), and testIonisation().

SoftwarePtr pwiz::msdata::InstrumentConfiguration::softwarePtr

reference to a previously defined software element.

Definition at line 236 of file MSData.hpp.

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

ScanSettingsPtr pwiz::msdata::InstrumentConfiguration::scanSettingsPtr

reference to a scan settings element defining global scan settings used by this configuration

Definition at line 239 of file MSData.hpp.


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