Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
SpectrumSettings.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-2013.
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_SPECTRUMSETTINGS_H
36 #define OPENMS_METADATA_SPECTRUMSETTINGS_H
37 
46 
47 #include <map>
48 #include <vector>
49 
50 namespace OpenMS
51 {
64  class OPENMS_DLLAPI SpectrumSettings :
65  public MetaInfoInterface
66  {
67 
68 public:
69 
72  {
76  SIZE_OF_SPECTRUMTYPE
77  };
79  static const std::string NamesOfSpectrumType[SIZE_OF_SPECTRUMTYPE];
80 
84  SpectrumSettings(const SpectrumSettings & source);
87 
88  // Assignment operator
89  SpectrumSettings & operator=(const SpectrumSettings & source);
90 
92  bool operator==(const SpectrumSettings & rhs) const;
94  bool operator!=(const SpectrumSettings & rhs) const;
95 
97  void unify(const SpectrumSettings & rhs);
98 
100  SpectrumType getType() const;
102  void setType(SpectrumType type);
103 
105  const String & getNativeID() const;
107  void setNativeID(const String & native_id);
108 
110  const String & getComment() const;
112  void setComment(const String & comment);
113 
115  const InstrumentSettings & getInstrumentSettings() const;
117  InstrumentSettings & getInstrumentSettings();
119  void setInstrumentSettings(const InstrumentSettings & instrument_settings);
120 
122  const AcquisitionInfo & getAcquisitionInfo() const;
124  AcquisitionInfo & getAcquisitionInfo();
126  void setAcquisitionInfo(const AcquisitionInfo & acquisition_info);
127 
129  const SourceFile & getSourceFile() const;
131  SourceFile & getSourceFile();
133  void setSourceFile(const SourceFile & source_file);
134 
136  const std::vector<Precursor> & getPrecursors() const;
138  std::vector<Precursor> & getPrecursors();
140  void setPrecursors(const std::vector<Precursor> & precursors);
141 
143  const std::vector<Product> & getProducts() const;
145  std::vector<Product> & getProducts();
147  void setProducts(const std::vector<Product> & products);
148 
150  const std::vector<PeptideIdentification> & getPeptideIdentifications() const;
152  std::vector<PeptideIdentification> & getPeptideIdentifications();
154  void setPeptideIdentifications(const std::vector<PeptideIdentification> & identifications);
155 
157  const std::vector<DataProcessing> & getDataProcessing() const;
159  std::vector<DataProcessing> & getDataProcessing();
161  void setDataProcessing(const std::vector<DataProcessing> & data_processing);
162 
163 protected:
164 
171  std::vector<Precursor> precursors_;
172  std::vector<Product> products_;
173  std::vector<PeptideIdentification> identification_;
174  std::vector<DataProcessing> data_processing_;
175  };
176 
178  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const SpectrumSettings & spec);
179 
180 } // namespace OpenMS
181 
182 #endif // OPENMS_METADATA_SPECTRUMSETTINGS_H
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:48
A more convenient string class.
Definition: String.h:56
Peak data (also called centroided data or stick data)
Definition: SpectrumSettings.h:74
std::vector< Precursor > precursors_
Definition: SpectrumSettings.h:171
SpectrumType
Spectrum peak type.
Definition: SpectrumSettings.h:71
Description of the combination of raw data to a single spectrum.
Definition: AcquisitionInfo.h:54
std::ostream & operator<<(std::ostream &os, const ItraqQuantifier::ItraqQuantifierStats &stats)
Representation of 1D spectrum settings.
Definition: SpectrumSettings.h:64
Description of a file location, used to store the origin of (meta) data.
Definition: SourceFile.h:47
Raw data (also called profile data)
Definition: SpectrumSettings.h:75
Unknown spectrum type.
Definition: SpectrumSettings.h:73
InstrumentSettings instrument_settings_
Definition: SpectrumSettings.h:168
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
SpectrumType type_
Definition: SpectrumSettings.h:165
SourceFile source_file_
Definition: SpectrumSettings.h:169
AcquisitionInfo acquisition_info_
Definition: SpectrumSettings.h:170
String native_id_
Definition: SpectrumSettings.h:166
std::vector< Product > products_
Definition: SpectrumSettings.h:172
String comment_
Definition: SpectrumSettings.h:167
std::vector< DataProcessing > data_processing_
Definition: SpectrumSettings.h:174
std::vector< PeptideIdentification > identification_
Definition: SpectrumSettings.h:173

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:21 using doxygen 1.8.5