Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2015.
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: Andreas Bertsch $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_INSTRUMENTSETTINGS_H
36 #define OPENMS_METADATA_INSTRUMENTSETTINGS_H
37 
40 
41 namespace OpenMS
42 {
48  class OPENMS_DLLAPI InstrumentSettings :
49  public MetaInfoInterface
50  {
51 public:
53  enum ScanMode
54  {
59  SIM,
60  SRM,
61  CRM,
62  CNG,
63  CNL,
65  EMC,
66  TDF,
67  EMR,
70  SIZE_OF_SCANMODE
71  };
72 
74  static const std::string NamesOfScanMode[SIZE_OF_SCANMODE];
75 
79  InstrumentSettings(const InstrumentSettings & source);
82 
84  InstrumentSettings & operator=(const InstrumentSettings & source);
85 
87  bool operator==(const InstrumentSettings & rhs) const;
89  bool operator!=(const InstrumentSettings & rhs) const;
90 
92  ScanMode getScanMode() const;
94  void setScanMode(ScanMode scan_mode);
95 
97  bool getZoomScan() const;
99  void setZoomScan(bool zoom_scan);
100 
102  IonSource::Polarity getPolarity() const;
104  void setPolarity(IonSource::Polarity polarity);
105 
107  const std::vector<ScanWindow> & getScanWindows() const;
109  std::vector<ScanWindow> & getScanWindows();
111  void setScanWindows(std::vector<ScanWindow> scan_windows);
112 
113 protected:
117  std::vector<ScanWindow> scan_windows_;
118  };
119 } // namespace OpenMS
120 
121 #endif // OPENMS_METADATA_INSTRUMENTSETTINGS_H
general spectrum type
Definition: InstrumentSettings.h:56
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:48
Polarity
Polarity of the ion source.
Definition: IonSource.h:140
Unknown scan method.
Definition: InstrumentSettings.h:55
Enhanced multiply charged scan.
Definition: InstrumentSettings.h:65
IonSource::Polarity polarity_
Definition: InstrumentSettings.h:116
Emission scan.
Definition: InstrumentSettings.h:68
Constant neutral loss scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:63
MS2+ mass spectrum, is a "mass spectrum".
Definition: InstrumentSettings.h:58
Time-delayed fragmentation scan.
Definition: InstrumentSettings.h:66
ScanMode scan_mode_
Definition: InstrumentSettings.h:114
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Selected reaction monitoring scan Synonyms: 'Multiple reaction monitoring scan', 'SRM scan', 'MRM scan'.
Definition: InstrumentSettings.h:60
bool zoom_scan_
Definition: InstrumentSettings.h:115
Selected ion monitoring scan Synonyms: 'Multiple ion monitoring scan', 'SIM scan', 'MIM scan'.
Definition: InstrumentSettings.h:59
full scan mass spectrum, is a "mass spectrum" Synonyms: 'full spectrum', 'Q1 spectrum', 'Q3 spectrum', 'Single-Stage Mass Spectrometry'
Definition: InstrumentSettings.h:57
Absorbtion scan.
Definition: InstrumentSettings.h:69
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:56
std::vector< ScanWindow > scan_windows_
Definition: InstrumentSettings.h:117
Consecutive reaction monitoring scan Synonyms: 'CRM scan'.
Definition: InstrumentSettings.h:61
Electromagnetic radiation scan Synonyms: 'EMR spectrum'.
Definition: InstrumentSettings.h:67
Precursor ion scan.
Definition: InstrumentSettings.h:64
Constant neutral gain scan Synonyms: 'CNG scan'.
Definition: InstrumentSettings.h:62
ScanMode
scan mode
Definition: InstrumentSettings.h:53

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:21 using doxygen 1.8.9.1