OpenMS  3.0.0
InstrumentSettings.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
47  class OPENMS_DLLAPI InstrumentSettings :
48  public MetaInfoInterface
49  {
50 public:
52  enum ScanMode
53  {
58  SIM,
59  SRM,
60  CRM,
61  CNG,
62  CNL,
64  EMC,
65  TDF,
66  EMR,
69  SIZE_OF_SCANMODE
70  };
71 
73  static const std::string NamesOfScanMode[SIZE_OF_SCANMODE];
74 
78  InstrumentSettings(const InstrumentSettings &) = default;
83 
85  InstrumentSettings & operator=(const InstrumentSettings &) = default;
87  InstrumentSettings& operator=(InstrumentSettings&&) & = default;
88 
90  bool operator==(const InstrumentSettings & rhs) const;
92  bool operator!=(const InstrumentSettings & rhs) const;
93 
95  ScanMode getScanMode() const;
97  void setScanMode(ScanMode scan_mode);
98 
100  bool getZoomScan() const;
102  void setZoomScan(bool zoom_scan);
103 
105  IonSource::Polarity getPolarity() const;
107  void setPolarity(IonSource::Polarity polarity);
108 
110  const std::vector<ScanWindow> & getScanWindows() const;
112  std::vector<ScanWindow> & getScanWindows();
114  void setScanWindows(std::vector<ScanWindow> scan_windows);
115 
116 protected:
120  std::vector<ScanWindow> scan_windows_;
121  };
122 } // namespace OpenMS
123 
OpenMS::InstrumentSettings::scan_mode_
ScanMode scan_mode_
Definition: InstrumentSettings.h:117
OpenMS::InstrumentSettings::MS1SPECTRUM
full scan mass spectrum, is a "mass spectrum" Synonyms: 'full spectrum', 'Q1 spectrum',...
Definition: InstrumentSettings.h:56
OpenMS::InstrumentSettings::polarity_
IonSource::Polarity polarity_
Definition: InstrumentSettings.h:119
OpenMS::InstrumentSettings::MASSSPECTRUM
general spectrum type
Definition: InstrumentSettings.h:55
OpenMS::InstrumentSettings
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:47
OpenMS::InstrumentSettings::TDF
Time-delayed fragmentation scan.
Definition: InstrumentSettings.h:65
OpenMS::InstrumentSettings::PRECURSOR
Precursor ion scan.
Definition: InstrumentSettings.h:63
OpenMS::IonSource::Polarity
Polarity
Polarity of the ion source.
Definition: IonSource.h:140
IonSource.h
OpenMS::InstrumentSettings::SIM
Selected ion monitoring scan Synonyms: 'Multiple ion monitoring scan', 'SIM scan',...
Definition: InstrumentSettings.h:58
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::InstrumentSettings::EMISSION
Emission scan.
Definition: InstrumentSettings.h:67
OpenMS::InstrumentSettings::scan_windows_
std::vector< ScanWindow > scan_windows_
Definition: InstrumentSettings.h:120
OpenMS::InstrumentSettings::SRM
Selected reaction monitoring scan Synonyms: 'Multiple reaction monitoring scan',...
Definition: InstrumentSettings.h:59
OpenMS::InstrumentSettings::EMR
Electromagnetic radiation scan Synonyms: 'EMR spectrum'.
Definition: InstrumentSettings.h:66
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::InstrumentSettings::MSNSPECTRUM
MS2+ mass spectrum, is a "mass spectrum".
Definition: InstrumentSettings.h:57
OpenMS::InstrumentSettings::UNKNOWN
Unknown scan method.
Definition: InstrumentSettings.h:54
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::InstrumentSettings::EMC
Enhanced multiply charged scan.
Definition: InstrumentSettings.h:64
OpenMS::InstrumentSettings::CNL
Constant neutral loss scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:62
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)
ScanWindow.h
OpenMS::InstrumentSettings::ABSORPTION
Absorption scan.
Definition: InstrumentSettings.h:68
OpenMS::InstrumentSettings::CNG
Constant neutral gain scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:61
OpenMS::InstrumentSettings::ScanMode
ScanMode
scan mode
Definition: InstrumentSettings.h:52
OpenMS::InstrumentSettings::zoom_scan_
bool zoom_scan_
Definition: InstrumentSettings.h:118
OpenMS::InstrumentSettings::CRM
Consecutive reaction monitoring scan Synonyms: 'CRM scan'.
Definition: InstrumentSettings.h:60