OpenMS
2.5.0
|
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, ABSORPTION, SIZE_OF_SCANMODE } |
scan mode More... | |
Public Member Functions | |
InstrumentSettings () | |
Constructor. More... | |
InstrumentSettings (const InstrumentSettings &)=default | |
Copy constructor. More... | |
InstrumentSettings (InstrumentSettings &&)=default | |
Move constructor. More... | |
~InstrumentSettings () | |
Destructor. More... | |
InstrumentSettings & | operator= (const InstrumentSettings &)=default |
Assignment operator. More... | |
InstrumentSettings & | operator= (InstrumentSettings &&) &=default |
Move 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 (MetaInfoInterface &&) noexcept | |
Move constructor. More... | |
~MetaInfoInterface () | |
Destructor. More... | |
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) |
Assignment operator. More... | |
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept |
Move 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 DataValue &default_value=DataValue::EMPTY) const |
Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More... | |
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const |
Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not found. More... | |
bool | metaValueExists (const String &name) const |
Returns whether an entry with the given name exists. More... | |
bool | metaValueExists (UInt index) const |
Returns whether an entry with the given index exists. 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 | 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 () |
Returns 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. |
ABSORPTION | Absorption scan. |
SIZE_OF_SCANMODE |
Constructor.
|
default |
Copy constructor.
|
default |
Move constructor.
~InstrumentSettings | ( | ) |
Destructor.
IonSource::Polarity getPolarity | ( | ) | const |
returns the polarity
Referenced by HasScanPolarity< SpectrumType >::operator()().
ScanMode getScanMode | ( | ) | const |
returns the scan mode
Referenced by HasScanMode< SpectrumType >::operator()().
std::vector<ScanWindow>& getScanWindows | ( | ) |
returns a mutable reference to the m/z scan windows
const std::vector<ScanWindow>& getScanWindows | ( | ) | const |
returns a const reference to the m/z scan windows
bool getZoomScan | ( | ) | const |
return if this scan is a zoom (enhanced resolution) scan
Referenced by IsZoomSpectrum< SpectrumType >::operator()().
bool operator!= | ( | const InstrumentSettings & | rhs | ) | const |
Equality operator.
|
default |
Assignment operator.
|
default |
Move assignment operator.
bool operator== | ( | const InstrumentSettings & | rhs | ) | const |
Equality operator.
void setPolarity | ( | IonSource::Polarity | polarity | ) |
sets the polarity
Referenced by XMassFile::load().
void setScanMode | ( | ScanMode | scan_mode | ) |
sets the scan mode
Referenced by XMassFile::load().
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().
|
static |
Names of scan modes.
|
protected |
|
protected |
|
protected |
|
protected |