OpenMS
InstrumentSettings.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Marc Sturm $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
13 
14 namespace OpenMS
15 {
21  class OPENMS_DLLAPI InstrumentSettings :
22  public MetaInfoInterface
23  {
24 public:
26  enum ScanMode
27  {
32  SIM,
33  SRM,
34  CRM,
35  CNG,
36  CNL,
38  EMC,
39  TDF,
40  EMR,
43  SIZE_OF_SCANMODE
44  };
45 
47  static const std::string NamesOfScanMode[SIZE_OF_SCANMODE];
48 
57 
62 
64  bool operator==(const InstrumentSettings & rhs) const;
66  bool operator!=(const InstrumentSettings & rhs) const;
67 
71  void setScanMode(ScanMode scan_mode);
72 
74  bool getZoomScan() const;
76  void setZoomScan(bool zoom_scan);
77 
82 
84  const std::vector<ScanWindow> & getScanWindows() const;
86  std::vector<ScanWindow> & getScanWindows();
88  void setScanWindows(std::vector<ScanWindow> scan_windows);
89 
90 protected:
92  bool zoom_scan_;
94  std::vector<ScanWindow> scan_windows_;
95  };
96 } // namespace OpenMS
97 
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:23
ScanMode getScanMode() const
returns the scan mode
void setPolarity(IonSource::Polarity polarity)
sets the polarity
IonSource::Polarity polarity_
Definition: InstrumentSettings.h:93
bool zoom_scan_
Definition: InstrumentSettings.h:92
InstrumentSettings & operator=(const InstrumentSettings &)=default
Assignment operator.
InstrumentSettings()
Constructor.
IonSource::Polarity getPolarity() const
returns the polarity
bool operator==(const InstrumentSettings &rhs) const
Equality operator.
std::vector< ScanWindow > & getScanWindows()
returns a mutable reference to the m/z scan windows
InstrumentSettings(InstrumentSettings &&)=default
Move constructor.
void setZoomScan(bool zoom_scan)
sets if this scan is a zoom (enhanced resolution) scan
std::vector< ScanWindow > scan_windows_
Definition: InstrumentSettings.h:94
bool operator!=(const InstrumentSettings &rhs) const
Equality operator.
InstrumentSettings & operator=(InstrumentSettings &&) &=default
Move assignment operator.
ScanMode scan_mode_
Definition: InstrumentSettings.h:91
void setScanWindows(std::vector< ScanWindow > scan_windows)
sets the m/z scan windows
~InstrumentSettings()
Destructor.
void setScanMode(ScanMode scan_mode)
sets the scan mode
InstrumentSettings(const InstrumentSettings &)=default
Copy constructor.
bool getZoomScan() const
return if this scan is a zoom (enhanced resolution) scan
const std::vector< ScanWindow > & getScanWindows() const
returns a const reference to the m/z scan windows
ScanMode
scan mode
Definition: InstrumentSettings.h:27
@ MASSSPECTRUM
general spectrum type
Definition: InstrumentSettings.h:29
@ SRM
Selected reaction monitoring scan Synonyms: 'Multiple reaction monitoring scan',...
Definition: InstrumentSettings.h:33
@ EMR
Electromagnetic radiation scan Synonyms: 'EMR spectrum'.
Definition: InstrumentSettings.h:40
@ TDF
Time-delayed fragmentation scan.
Definition: InstrumentSettings.h:39
@ EMISSION
Emission scan.
Definition: InstrumentSettings.h:41
@ UNKNOWN
Unknown scan method.
Definition: InstrumentSettings.h:28
@ PRECURSOR
Precursor ion scan.
Definition: InstrumentSettings.h:37
@ MS1SPECTRUM
full scan mass spectrum, is a "mass spectrum" Synonyms: 'full spectrum', 'Q1 spectrum',...
Definition: InstrumentSettings.h:30
@ CNG
Constant neutral gain scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:35
@ ABSORPTION
Absorption scan.
Definition: InstrumentSettings.h:42
@ EMC
Enhanced multiply charged scan.
Definition: InstrumentSettings.h:38
@ SIM
Selected ion monitoring scan Synonyms: 'Multiple ion monitoring scan', 'SIM scan',...
Definition: InstrumentSettings.h:32
@ MSNSPECTRUM
MS2+ mass spectrum, is a "mass spectrum".
Definition: InstrumentSettings.h:31
@ CRM
Consecutive reaction monitoring scan Synonyms: 'CRM scan'.
Definition: InstrumentSettings.h:34
@ CNL
Constant neutral loss scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:36
Polarity
Polarity of the ion source.
Definition: IonSource.h:115
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:35
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19