Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
TraMLFile.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-2017.
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: Timo Sachsenberg $
32 // $Authors: Andreas Bertsch$
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_TRAMLFILE_H
36 #define OPENMS_FORMAT_TRAMLFILE_H
37 
38 #include <OpenMS/FORMAT/XMLFile.h>
41 
42 namespace OpenMS
43 {
44  class Identification;
45  class TargetedExperiment;
46 
52  class OPENMS_DLLAPI TraMLFile :
53  public Internal::XMLFile,
54  public ProgressLogger
55  {
56 public:
58  TraMLFile();
60  virtual ~TraMLFile();
61 
68  void load(const String & filename, TargetedExperiment & id);
69 
75  void store(const String & filename, const TargetedExperiment & id) const;
76 
86  bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings);
87 
88 private:
89 
90  };
91 
92 } // namespace OpenMS
93 
94 #endif // OPENMS_FORMAT_TRAMLFILE_H
95 
A more convenient string class.
Definition: String.h:57
File adapter for HUPO PSI TraML files.
Definition: TraMLFile.h:52
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
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
A description of a targeted experiment containing precursor and production ions.
Definition: TargetedExperiment.h:62
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:49

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:04 using doxygen 1.8.13