Description of the settings a MS Instrument was run with. More...
#include <OpenMS/METADATA/InstrumentSettings.h>
 
  
 | Public Types | |
| enum | ScanMode { UNKNOWN, MASSSPECTRUM, MS1SPECTRUM, MSNSPECTRUM, SIM, SRM, CRM, CNG, CNL, PRECURSOR, EMC, TDF, EMR, EMISSION, ABSORBTION, SIZE_OF_SCANMODE } | 
| scan mode  More... | |
| Public Member Functions | |
| InstrumentSettings () | |
| Constructor.  More... | |
| InstrumentSettings (const InstrumentSettings &source) | |
| Copy constructor.  More... | |
| ~InstrumentSettings () | |
| Destructor.  More... | |
| InstrumentSettings & | operator= (const InstrumentSettings &source) | 
| Assignment operator.  More... | |
| bool | operator== (const InstrumentSettings &rhs) const | 
| Equality operator.  More... | |
| bool | operator!= (const InstrumentSettings &rhs) const | 
| Equality operator.  More... | |
| ScanMode | getScanMode () const | 
| returns the scan mode  More... | |
| void | setScanMode (ScanMode scan_mode) | 
| sets the scan mode  More... | |
| bool | getZoomScan () const | 
| return if this scan is a zoom (enhanced resolution) scan  More... | |
| void | setZoomScan (bool zoom_scan) | 
| sets if this scan is a zoom (enhanced resolution) scan  More... | |
| IonSource::Polarity | getPolarity () const | 
| returns the polarity  More... | |
| void | setPolarity (IonSource::Polarity polarity) | 
| sets the polarity  More... | |
| const std::vector< ScanWindow > & | getScanWindows () const | 
| returns a const reference to the m/z scan windows  More... | |
| std::vector< ScanWindow > & | getScanWindows () | 
| returns a mutable reference to the m/z scan windows  More... | |
| void | setScanWindows (std::vector< ScanWindow > scan_windows) | 
| sets the m/z scan windows  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 nameif it exists.  More... | |
| void | removeMetaValue (UInt index) | 
| Removes the DataValue corresponding to indexif 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 | NamesOfScanMode [SIZE_OF_SCANMODE] | 
| Names of scan modes.  More... | |
| Protected Attributes | |
| ScanMode | scan_mode_ | 
| bool | zoom_scan_ | 
| IonSource::Polarity | polarity_ | 
| std::vector< ScanWindow > | scan_windows_ | 
|  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 the settings a MS Instrument was run with.
| enum ScanMode | 
scan mode
| Enumerator | |
|---|---|
| UNKNOWN | Unknown scan method. | 
| MASSSPECTRUM | general spectrum type | 
| MS1SPECTRUM | full scan mass spectrum, is a "mass spectrum"  | 
| MSNSPECTRUM | MS2+ mass spectrum, is a "mass spectrum". | 
| SIM | Selected ion monitoring scan  | 
| SRM | Selected reaction monitoring scan  | 
| CRM | Consecutive reaction monitoring scan  | 
| CNG | Constant neutral gain scan  | 
| CNL | Constant neutral loss scan  | 
| PRECURSOR | Precursor ion scan. | 
| EMC | Enhanced multiply charged scan. | 
| TDF | Time-delayed fragmentation scan. | 
| EMR | Electromagnetic radiation scan  | 
| EMISSION | Emission scan. | 
| ABSORBTION | Absorbtion scan. | 
| SIZE_OF_SCANMODE | |
Constructor.
| InstrumentSettings | ( | const InstrumentSettings & | source | ) | 
Copy constructor.
| ~InstrumentSettings | ( | ) | 
Destructor.
| IonSource::Polarity getPolarity | ( | ) | const | 
returns the polarity
Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeSpectrum_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| ScanMode getScanMode | ( | ) | const | 
returns the scan mode
Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeSpectrum_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| const std::vector<ScanWindow>& getScanWindows | ( | ) | const | 
returns a const reference to the m/z scan windows
Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeSpectrum_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| std::vector<ScanWindow>& getScanWindows | ( | ) | 
returns a mutable reference to the m/z scan windows
| bool getZoomScan | ( | ) | const | 
return if this scan is a zoom (enhanced resolution) scan
Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeSpectrum_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| bool operator!= | ( | const InstrumentSettings & | rhs | ) | const | 
Equality operator.
| InstrumentSettings& operator= | ( | const InstrumentSettings & | source | ) | 
Assignment operator.
| bool operator== | ( | const InstrumentSettings & | rhs | ) | const | 
Equality operator.
| void setPolarity | ( | IonSource::Polarity | polarity | ) | 
sets the polarity
Referenced by XMassFile::load(), and DBAdapter::loadSpectrum().
| void setScanMode | ( | ScanMode | scan_mode | ) | 
sets the scan mode
Referenced by XMassFile::load(), and DBAdapter::loadSpectrum().
| void setScanWindows | ( | std::vector< ScanWindow > | scan_windows | ) | 
sets the m/z scan windows
| void setZoomScan | ( | bool | zoom_scan | ) | 
sets if this scan is a zoom (enhanced resolution) scan
Referenced by XMassFile::load(), and DBAdapter::loadSpectrum().
| 
 | static | 
Names of scan modes.
Referenced by MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().
| 
 | protected | 
| 
 | protected | 
| 
 | protected | 
| 
 | protected | 
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |