Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MzDataFile.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-2015.
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_MZDATAFILE_H
36 #define OPENMS_FORMAT_MZDATAFILE_H
37 
38 #include <OpenMS/FORMAT/XMLFile.h>
43 
44 namespace OpenMS
45 {
51  class OPENMS_DLLAPI MzDataFile :
52  public Internal::XMLFile,
53  public ProgressLogger
54  {
55 
56 public:
57 
59  MzDataFile();
61  ~MzDataFile();
62 
64  PeakFileOptions & getOptions();
65 
67  const PeakFileOptions & getOptions() const;
68 
70  void setOptions(const PeakFileOptions &);
71 
80  template <typename MapType>
81  void load(const String & filename, MapType & map)
82  {
83  map.reset();
84 
85  //set DocumentIdentifier
86  map.setLoadedFileType(filename);
87  map.setLoadedFilePath(filename);
88 
89  Internal::MzDataHandler<MapType> handler(map, filename, schema_version_, *this);
90  handler.setOptions(options_);
91  parse_(filename, &handler);
92  }
93 
101  template <typename MapType>
102  void store(const String & filename, const MapType & map) const
103  {
104  Internal::MzDataHandler<MapType> handler(map, filename, schema_version_, *this);
105  handler.setOptions(options_);
106  save_(filename, &handler);
107  }
108 
118  bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings);
119 
120 private:
121 
124  };
125 
126 } // namespace OpenMS
127 
128 #endif // OPENMS_FOMAT_MZXMLFILE_H
XML handler for MzDataFile.
Definition: MzDataHandler.h:60
A more convenient string class.
Definition: String.h:57
void reset()
Resets all internal values.
Definition: MSExperiment.h:660
void setOptions(const PeakFileOptions &options)
Sets the options.
Definition: MzDataHandler.h:115
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
void setLoadedFileType(const String &file_name)
set the file_type according to the type of the file loaded from (see FileHandler::Type) preferably do...
File adapter for MzData files.
Definition: MzDataFile.h:51
void store(const String &filename, const MapType &map) const
Stores a map in a MzData file.
Definition: MzDataFile.h:102
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:55
void setLoadedFilePath(const String &file_name)
set the file_name_ according to absolute path of the file loaded from preferably done whilst loading ...
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:53
PeakFileOptions options_
Options for loading / storing.
Definition: MzDataFile.h:123
Options for loading files containing peak data.
Definition: PeakFileOptions.h:48
void load(const String &filename, MapType &map)
Loads a map from a MzData file.
Definition: MzDataFile.h:81

OpenMS / TOPP release 2.0.0 Documentation generated on Thu Aug 20 2015 01:44:26 using doxygen 1.8.9.1