ProteoWizard
|
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>
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 More... | |
![]() | |
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< CVParam > | cvParamChildren (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 | |
std::string | id |
an identifier for this instrument configuration. More... | |
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. More... | |
SoftwarePtr | softwarePtr |
reference to a previously defined software element. More... | |
ScanSettingsPtr | scanSettingsPtr |
reference to a scan settings element defining global scan settings used by this configuration More... | |
![]() | |
std::vector< ParamGroupPtr > | paramGroupPtrs |
a collection of references to ParamGroups More... | |
std::vector< CVParam > | cvParams |
a collection of controlled vocabulary terms More... | |
std::vector< UserParam > | userParams |
a collection of uncontrolled user terms More... | |
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 228 of file MSData.hpp.
pwiz::msdata::InstrumentConfiguration::InstrumentConfiguration | ( | const std::string & | _id = "" | ) |
bool pwiz::msdata::InstrumentConfiguration::empty | ( | ) | const |
returns true iff the element contains no params and all members are empty or null
std::string pwiz::msdata::InstrumentConfiguration::id |
an identifier for this instrument configuration.
Definition at line 231 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 234 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 237 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 240 of file MSData.hpp.