Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MzXMLFile.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_FORMAT_MZXMLFILE_H
36 #define OPENMS_FORMAT_MZXMLFILE_H
37 
38 #include <OpenMS/FORMAT/XMLFile.h>
42 
43 namespace OpenMS
44 {
45  class String;
46 
52  class OPENMS_DLLAPI MzXMLFile :
53  public Internal::XMLFile,
54  public ProgressLogger
55  {
56 public:
58  MzXMLFile();
60  ~MzXMLFile();
61 
63  PeakFileOptions & getOptions();
64 
66  const PeakFileOptions & getOptions() const;
67 
69  void setOptions(const PeakFileOptions &);
70 
79  template <typename MapType>
80  void load(const String & filename, MapType & map)
81  {
82  map.reset();
83 
84  //set DocumentIdentifier
85  map.setLoadedFileType(filename);
86  map.setLoadedFilePath(filename);
87 
88  Internal::MzXMLHandler<MapType> handler(map, filename, schema_version_, *this);
89  handler.setOptions(options_);
90  parse_(filename, &handler);
91  }
92 
100  template <typename MapType>
101  void store(const String & filename, const MapType & map) const
102  {
103  Internal::MzXMLHandler<MapType> handler(map, filename, schema_version_, *this);
104  save_(filename, &handler);
105  }
106 
107 private:
109  };
110 } // namespace OpenMS
111 
112 #endif // OPENMS_FOMAT_MZXMLFILE_H
PeakFileOptions options_
Definition: MzXMLFile.h:108
void store(const String &filename, const MapType &map) const
Stores a map in a MzXML file.
Definition: MzXMLFile.h:101
A more convenient string class.
Definition: String.h:56
File adapter for MzXML 2.1 files.
Definition: MzXMLFile.h:52
void load(const String &filename, MapType &map)
Loads a map from a MzXML file.
Definition: MzXMLFile.h:80
XML handlers for MzXMLFile.
Definition: MzXMLHandler.h:60
void setOptions(const PeakFileOptions &options)
Sets the options.
Definition: MzXMLHandler.h:116
Base class for all classes that want to report their progess.
Definition: ProgressLogger.h:56
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:51
Options for loading files containing peak data.
Definition: PeakFileOptions.h:47

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