Description of a MS instrument. More...
#include <OpenMS/METADATA/Instrument.h>
Public Types | |
| enum | IonOpticsType { UNKNOWN, MAGNETIC_DEFLECTION, DELAYED_EXTRACTION, COLLISION_QUADRUPOLE, SELECTED_ION_FLOW_TUBE, TIME_LAG_FOCUSING, REFLECTRON, EINZEL_LENS, FIRST_STABILITY_REGION, FRINGING_FIELD, KINETIC_ENERGY_ANALYZER, STATIC_FIELD, SIZE_OF_IONOPTICSTYPE } |
| ion optics type More... | |
Public Member Functions | |
| Instrument () | |
| Constructor. More... | |
| Instrument (const Instrument &source) | |
| Copy constructor. More... | |
| ~Instrument () | |
| Destructor. More... | |
| Instrument & | operator= (const Instrument &source) |
| Assignement operator. More... | |
| bool | operator== (const Instrument &rhs) const |
| Equality operator. More... | |
| bool | operator!= (const Instrument &rhs) const |
| Equality operator. More... | |
| const String & | getName () const |
| returns the name of the instrument More... | |
| void | setName (const String &name) |
| sets the name of the instrument More... | |
| const String & | getVendor () const |
| returns the instrument vendor More... | |
| void | setVendor (const String &vendor) |
| sets the instrument vendor More... | |
| const String & | getModel () const |
| returns the instrument model More... | |
| void | setModel (const String &model) |
| sets the instrument model More... | |
| const String & | getCustomizations () const |
| returns a description of customizations More... | |
| void | setCustomizations (const String &customizations) |
| sets the a description of customizations More... | |
| const std::vector< IonSource > & | getIonSources () const |
| returns a const reference to the ion source list More... | |
| std::vector< IonSource > & | getIonSources () |
| returns a mutable reference to the ion source list More... | |
| void | setIonSources (const std::vector< IonSource > &ion_sources) |
| sets the ion source list More... | |
| const std::vector< MassAnalyzer > & | getMassAnalyzers () const |
| returns a const reference to the mass analyer list More... | |
| std::vector< MassAnalyzer > & | getMassAnalyzers () |
| returns a mutable reference to the mass analyzer list More... | |
| void | setMassAnalyzers (const std::vector< MassAnalyzer > &mass_analyzers) |
| sets the mass analyzer list More... | |
| const std::vector< IonDetector > & | getIonDetectors () const |
| returns a const reference to the ion detector list More... | |
| std::vector< IonDetector > & | getIonDetectors () |
| returns a mutable reference to the ion detector list More... | |
| void | setIonDetectors (const std::vector< IonDetector > &ion_detectors) |
| sets the ion detector list More... | |
| const Software & | getSoftware () const |
| returns a const reference to the instrument software More... | |
| Software & | getSoftware () |
| returns a mutable reference to the instrument software More... | |
| void | setSoftware (const Software &software) |
| sets the instrument software More... | |
| IonOpticsType | getIonOptics () const |
| returns the ion optics type More... | |
| void | setIonOptics (IonOpticsType ion_optics) |
| sets the ion optics type More... | |
Public Member Functions inherited from MetaInfoInterface | |
| MetaInfoInterface () | |
| constructor More... | |
| MetaInfoInterface (const MetaInfoInterface &rhs) | |
| copy constructor More... | |
| ~MetaInfoInterface () | |
| destructor More... | |
| MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) |
| assignment operator More... | |
| bool | operator== (const MetaInfoInterface &rhs) const |
| Equality operator. More... | |
| bool | operator!= (const MetaInfoInterface &rhs) const |
| Equality operator. More... | |
| const DataValue & | getMetaValue (const String &name) const |
| returns the value corresponding to a string More... | |
| const DataValue & | getMetaValue (UInt index) const |
| returns the value corresponding to an index More... | |
| bool | metaValueExists (const String &name) const |
| returns if this MetaInfo is set More... | |
| bool | metaValueExists (UInt index) const |
| returns if this MetaInfo is set More... | |
| void | setMetaValue (const String &name, const DataValue &value) |
| sets the DataValue corresponding to a name More... | |
| void | setMetaValue (UInt index, const DataValue &value) |
| sets the DataValue corresponding to an index More... | |
| void | removeMetaValue (const String &name) |
Removes the DataValue corresponding to name if it exists. More... | |
| void | removeMetaValue (UInt index) |
Removes the DataValue corresponding to index if it exists. More... | |
| void | getKeys (std::vector< String > &keys) const |
| fills the given vector with a list of all keys for which a value is set More... | |
| void | getKeys (std::vector< UInt > &keys) const |
| fills the given vector with a list of all keys for which a value is set More... | |
| bool | isMetaEmpty () const |
| returns if the MetaInfo is empty More... | |
| void | clearMetaInfo () |
| removes all meta values More... | |
Static Public Attributes | |
| static const std::string | NamesOfIonOpticsType [SIZE_OF_IONOPTICSTYPE] |
| Names of inlet types. More... | |
Protected Attributes | |
| String | name_ |
| String | vendor_ |
| String | model_ |
| String | customizations_ |
| std::vector< IonSource > | ion_sources_ |
| std::vector< MassAnalyzer > | mass_analyzers_ |
| std::vector< IonDetector > | ion_detectors_ |
| Software | software_ |
| IonOpticsType | ion_optics_ |
Protected Attributes inherited from MetaInfoInterface | |
| MetaInfo * | meta_ |
| pointer to the MetaInfo object. 0 by default More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from MetaInfoInterface | |
| static MetaInfoRegistry & | metaRegistry () |
| retuns a reference to the MetaInfoRegistry More... | |
Protected Member Functions inherited from MetaInfoInterface | |
| void | createIfNotExists_ () |
| creates the MetaInfo object if it does not exist More... | |
Description of a MS instrument.
It contains information like vendor, model, ion source(s), mass analyzer(s), and ion detector(s).
The parts (IonSource, MassAnalyzer, IonDetector) all have a order member. The order can be ignored, as long the instrument has this default setup:
For more complex instuments, the order should be defined.
| enum IonOpticsType |
ion optics type
| Instrument | ( | ) |
Constructor.
| Instrument | ( | const Instrument & | source | ) |
Copy constructor.
| ~Instrument | ( | ) |
Destructor.
| const String& getCustomizations | ( | ) | const |
returns a description of customizations
Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeHeader_(), and MzDataHandler< MapType >::writeTo().
| const std::vector<IonDetector>& getIonDetectors | ( | ) | const |
returns a const reference to the ion detector list
Referenced by MzMLHandler< MapType >::writeHeader_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| std::vector<IonDetector>& getIonDetectors | ( | ) |
returns a mutable reference to the ion detector list
| IonOpticsType getIonOptics | ( | ) | const |
returns the ion optics type
Referenced by DBAdapter::storeExperiment(), and MzMLHandler< MapType >::writeHeader_().
| const std::vector<IonSource>& getIonSources | ( | ) | const |
returns a const reference to the ion source list
Referenced by XMassFile::importExperimentalSettings(), MzMLHandler< MapType >::writeHeader_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| std::vector<IonSource>& getIonSources | ( | ) |
returns a mutable reference to the ion source list
| const std::vector<MassAnalyzer>& getMassAnalyzers | ( | ) | const |
returns a const reference to the mass analyer list
Referenced by XMassFile::importExperimentalSettings(), MzMLHandler< MapType >::writeHeader_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| std::vector<MassAnalyzer>& getMassAnalyzers | ( | ) |
returns a mutable reference to the mass analyzer list
| const String& getModel | ( | ) | const |
returns the instrument model
Referenced by DBAdapter::storeExperiment(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| const String& getName | ( | ) | const |
returns the name of the instrument
Referenced by MzMLHandler< MapType >::writeHeader_(), and MzDataHandler< MapType >::writeTo().
| const Software& getSoftware | ( | ) | const |
returns a const reference to the instrument software
Referenced by DBAdapter::storeExperiment(), and MzXMLHandler< MapType >::writeTo().
| Software& getSoftware | ( | ) |
returns a mutable reference to the instrument software
| const String& getVendor | ( | ) | const |
returns the instrument vendor
Referenced by DBAdapter::storeExperiment(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| bool operator!= | ( | const Instrument & | rhs | ) | const |
Equality operator.
| Instrument& operator= | ( | const Instrument & | source | ) |
Assignement operator.
| bool operator== | ( | const Instrument & | rhs | ) | const |
Equality operator.
| void setCustomizations | ( | const String & | customizations | ) |
sets the a description of customizations
| void setIonDetectors | ( | const std::vector< IonDetector > & | ion_detectors | ) |
sets the ion detector list
| void setIonOptics | ( | IonOpticsType | ion_optics | ) |
sets the ion optics type
| void setIonSources | ( | const std::vector< IonSource > & | ion_sources | ) |
sets the ion source list
| void setMassAnalyzers | ( | const std::vector< MassAnalyzer > & | mass_analyzers | ) |
sets the mass analyzer list
| void setModel | ( | const String & | model | ) |
sets the instrument model
Referenced by XMassFile::importExperimentalSettings().
| void setName | ( | const String & | name | ) |
sets the name of the instrument
Referenced by XMassFile::importExperimentalSettings().
| void setSoftware | ( | const Software & | software | ) |
sets the instrument software
| void setVendor | ( | const String & | vendor | ) |
sets the instrument vendor
Referenced by XMassFile::importExperimentalSettings().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |
Names of inlet types.
|
protected |
|
protected |
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |