Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MzIdentMLFile.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: Andreas Bertsch, Mathias Walzer $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_MZIDENTMLFILE_H
36 #define OPENMS_FORMAT_MZIDENTMLFILE_H
37 
38 #include <OpenMS/FORMAT/XMLFile.h>
42 
45 
46 #include <vector>
47 
48 namespace OpenMS
49 {
57  class OPENMS_DLLAPI MzIdentMLFile :
58  public Internal::XMLFile,
59  public ProgressLogger
60  {
61 public:
63  MzIdentMLFile();
65  virtual ~MzIdentMLFile();
66 
73  void load(const String & filename, Identification & id);
74 
80  void store(const String & filename, const std::vector<ProteinIdentification> & poid, const std::vector<PeptideIdentification> & peid) const;
81 
87  void store(const String & filename, const Identification & id) const;
88 
98  bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings);
99 
100 private:
101 
102  };
103 
104 } // namespace OpenMS
105 
106 #endif // OPENMS_FORMAT_MZIDENTMLFILE_H
A more convenient string class.
Definition: String.h:56
File adapter for MzIdentML files.
Definition: MzIdentMLFile.h:57
Represents a object which can store the information of an analysisXML instance.
Definition: Identification.h:53
String list.
Definition: StringList.h:56
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

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