OpenMS
Loading...
Searching...
No Matches
TraMLFile.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Timo Sachsenberg $
6// $Authors: Andreas Bertsch$
7// --------------------------------------------------------------------------
8
9#pragma once
10
14
15namespace OpenMS
16{
17 class Identification;
18 class TargetedExperiment;
19
37 class OPENMS_DLLAPI TraMLFile :
38 public Internal::XMLFile,
39 public ProgressLogger
40 {
41public:
45 ~TraMLFile() override;
46
53 void load(const String & filename, TargetedExperiment & id);
54
60 void store(const String & filename, const TargetedExperiment & id) const;
61
71 bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings);
72
73private:
74
75 };
76
77} // namespace OpenMS
78
79
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition XMLFile.h:23
Base class for all classes that want to report their progress.
Definition ProgressLogger.h:27
A more convenient string class.
Definition String.h:34
A description of a targeted experiment containing precursor and production ions.
Definition TargetedExperiment.h:39
File adapter for HUPO PSI TraML files.
Definition TraMLFile.h:40
void store(const String &filename, const TargetedExperiment &id) const
Stores a map in a TraML file.
~TraMLFile() override
Destructor.
TraMLFile()
Default constructor.
void load(const String &filename, TargetedExperiment &id)
Loads a map from a TraML file.
bool isSemanticallyValid(const String &filename, StringList &errors, StringList &warnings)
Checks if a file is valid with respect to the mapping file and the controlled vocabulary.
std::vector< String > StringList
Vector of String.
Definition ListUtils.h:44
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19