Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ChromatogramSettings.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-2017.
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: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_CHROMATOGRAMSETTINGS_H
36 #define OPENMS_METADATA_CHROMATOGRAMSETTINGS_H
37 
45 
46 #include <map>
47 #include <vector>
48 
49 namespace OpenMS
50 {
59  class OPENMS_DLLAPI ChromatogramSettings :
60  public MetaInfoInterface
61  {
62 
63 public:
64 
68  {
69  MASS_CHROMATOGRAM = 0,
78  SIZE_OF_CHROMATOGRAM_TYPE // last entry!
79  };
80 
82  static const char * const ChromatogramNames[SIZE_OF_CHROMATOGRAM_TYPE+1]; // avoid string[], since it gets copied onto heap on initialization
83 
89  virtual ~ChromatogramSettings();
90 
91  // Assignment operator
92  ChromatogramSettings & operator=(const ChromatogramSettings & source);
93 
95  bool operator==(const ChromatogramSettings & rhs) const;
97  bool operator!=(const ChromatogramSettings & rhs) const;
98 
99 
101  const String & getNativeID() const;
103  void setNativeID(const String & native_id);
104 
106  const String & getComment() const;
108  void setComment(const String & comment);
109 
111  const InstrumentSettings & getInstrumentSettings() const;
113  InstrumentSettings & getInstrumentSettings();
115  void setInstrumentSettings(const InstrumentSettings & instrument_settings);
116 
118  const AcquisitionInfo & getAcquisitionInfo() const;
120  AcquisitionInfo & getAcquisitionInfo();
122  void setAcquisitionInfo(const AcquisitionInfo & acquisition_info);
123 
125  const SourceFile & getSourceFile() const;
127  SourceFile & getSourceFile();
129  void setSourceFile(const SourceFile & source_file);
130 
132  const Precursor & getPrecursor() const;
134  Precursor & getPrecursor();
136  void setPrecursor(const Precursor & precursor);
137 
139  const Product & getProduct() const;
141  Product & getProduct();
143  void setProduct(const Product & product);
144 
146  ChromatogramType getChromatogramType() const;
147 
149  void setChromatogramType(ChromatogramType type);
150 
152  void setDataProcessing(const std::vector< DataProcessingPtr > & data_processing);
153 
155  std::vector< DataProcessingPtr > & getDataProcessing();
156 
158  const std::vector< boost::shared_ptr<const DataProcessing > > getDataProcessing() const;
159 
160 protected:
161 
169  std::vector< DataProcessingPtr > data_processing_;
171  };
172 
174  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const ChromatogramSettings & spec);
175 
176 } // namespace OpenMS
177 
178 #endif // OPENMS_METADATA_CHROMATOGRAMSETTINGS_H
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:48
A more convenient string class.
Definition: String.h:57
Precursor meta information.
Definition: Precursor.h:58
AcquisitionInfo acquisition_info_
Definition: ChromatogramSettings.h:166
Product meta information.
Definition: Product.h:49
SourceFile source_file_
Definition: ChromatogramSettings.h:165
Description of the combination of raw data to a single spectrum.
Definition: AcquisitionInfo.h:53
InstrumentSettings instrument_settings_
Definition: ChromatogramSettings.h:164
Product product_
Definition: ChromatogramSettings.h:168
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Description of a file location, used to store the origin of (meta) data.
Definition: SourceFile.h:47
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Definition: ChromatogramSettings.h:72
Definition: ChromatogramSettings.h:76
ChromatogramType
Definition: ChromatogramSettings.h:67
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)
std::vector< DataProcessingPtr > data_processing_
Definition: ChromatogramSettings.h:169
Definition: ChromatogramSettings.h:77
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:56
Representation of chromatogram settings, e.g. SRM/MRM chromatograms.
Definition: ChromatogramSettings.h:59
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
ChromatogramType type_
Definition: ChromatogramSettings.h:170
String native_id_
Definition: ChromatogramSettings.h:162
Precursor precursor_
Definition: ChromatogramSettings.h:167
String comment_
Definition: ChromatogramSettings.h:163

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13