OpenMS  2.4.0
Instrument.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-2018.
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 
43 
44 #include <vector>
45 
46 namespace OpenMS
47 {
63  class OPENMS_DLLAPI Instrument :
64  public MetaInfoInterface
65  {
66 
67 public:
68 
71  {
84  SIZE_OF_IONOPTICSTYPE
85  };
87  static const std::string NamesOfIonOpticsType[SIZE_OF_IONOPTICSTYPE];
88 
90  Instrument();
92  Instrument(const Instrument & source);
94  ~Instrument();
95 
97  Instrument & operator=(const Instrument & source);
98 
100  bool operator==(const Instrument & rhs) const;
102  bool operator!=(const Instrument & rhs) const;
103 
105  const String & getName() const;
107  void setName(const String & name);
108 
110  const String & getVendor() const;
112  void setVendor(const String & vendor);
113 
115  const String & getModel() const;
117  void setModel(const String & model);
118 
120  const String & getCustomizations() const;
122  void setCustomizations(const String & customizations);
123 
125  const std::vector<IonSource> & getIonSources() const;
127  std::vector<IonSource> & getIonSources();
129  void setIonSources(const std::vector<IonSource> & ion_sources);
130 
132  const std::vector<MassAnalyzer> & getMassAnalyzers() const;
134  std::vector<MassAnalyzer> & getMassAnalyzers();
136  void setMassAnalyzers(const std::vector<MassAnalyzer> & mass_analyzers);
137 
139  const std::vector<IonDetector> & getIonDetectors() const;
141  std::vector<IonDetector> & getIonDetectors();
143  void setIonDetectors(const std::vector<IonDetector> & ion_detectors);
144 
146  const Software & getSoftware() const;
148  Software & getSoftware();
150  void setSoftware(const Software & software);
151 
153  IonOpticsType getIonOptics() const;
155  void setIonOptics(IonOpticsType ion_optics);
156 
157 protected:
158 
163  std::vector<IonSource> ion_sources_;
164  std::vector<MassAnalyzer> mass_analyzers_;
165  std::vector<IonDetector> ion_detectors_;
168  };
169 } // namespace OpenMS
170 
time lag focusing
Definition: Instrument.h:77
Description of a MS instrument.
Definition: Instrument.h:63
IonOpticsType ion_optics_
Definition: Instrument.h:167
A more convenient string class.
Definition: String.h:57
String model_
Definition: Instrument.h:161
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Description of the software used for processing.
Definition: Software.h:48
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
collision quadrupole
Definition: Instrument.h:75
String name_
Definition: Instrument.h:159
std::vector< IonSource > ion_sources_
Definition: Instrument.h:163
magnetic deflection
Definition: Instrument.h:73
String vendor_
Definition: Instrument.h:160
unknown
Definition: Instrument.h:72
std::vector< MassAnalyzer > mass_analyzers_
Definition: Instrument.h:164
delayed extraction
Definition: Instrument.h:74
first stability region
Definition: Instrument.h:80
fringing field
Definition: Instrument.h:81
reflectron
Definition: Instrument.h:78
IonOpticsType
ion optics type
Definition: Instrument.h:70
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:55
String customizations_
Definition: Instrument.h:162
selected ion flow tube
Definition: Instrument.h:76
Software software_
Definition: Instrument.h:166
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
einzel lens
Definition: Instrument.h:79
std::vector< IonDetector > ion_detectors_
Definition: Instrument.h:165
kinetic energy analyzer
Definition: Instrument.h:82
static field
Definition: Instrument.h:83