OpenMS  2.8.0
IndexedMzMLFileLoader.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-2021.
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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
42  class OnDiscMSExperiment;
44 
54  class OPENMS_DLLAPI IndexedMzMLFileLoader
55  {
56  public:
57 
60 
63 
66 
68  const PeakFileOptions& getOptions() const;
69 
71  void setOptions(const PeakFileOptions &);
72 
83  bool load(const String& filename, OnDiscPeakMap& exp);
84 
91  void store(const String& filename, OnDiscPeakMap& exp);
92 
99  void store(const String& filename, PeakMap& exp);
100 
101 private:
102 
105 
106  };
107 }
108 
109 
A class to load an indexedmzML file.
Definition: IndexedMzMLFileLoader.h:55
IndexedMzMLFileLoader()
Constructor.
void setOptions(const PeakFileOptions &)
set options for loading/storing
void store(const String &filename, OnDiscPeakMap &exp)
Store a file from an on-disc data-structure.
const PeakFileOptions & getOptions() const
Non-mutable access to the options for loading/storing.
PeakFileOptions options_
Options for storing.
Definition: IndexedMzMLFileLoader.h:104
PeakFileOptions & getOptions()
Mutable access to the options for loading/storing.
bool load(const String &filename, OnDiscPeakMap &exp)
Load a file.
void store(const String &filename, PeakMap &exp)
Store a file from an in-memory data-structure.
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:73
Representation of a mass spectrometry experiment on disk.
Definition: OnDiscMSExperiment.h:67
Options for loading files containing peak data.
Definition: PeakFileOptions.h:48
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::OnDiscMSExperiment OnDiscPeakMap
Definition: IndexedMzMLFileLoader.h:42