OpenMS
ConsensusXMLFile.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Clemens Groepl, Marc Sturm $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 #include <OpenMS/FORMAT/XMLFile.h>
15 
16 namespace OpenMS
17 {
18  class ConsensusMap;
32  class OPENMS_DLLAPI ConsensusXMLFile :
33  public Internal::XMLFile,
34  public ProgressLogger
35  {
36 public:
40  ~ConsensusXMLFile() override;
41 
49  void load(const String& filename, ConsensusMap& map);
50 
58  void store(const String& filename, const ConsensusMap& consensus_map);
59 
62 
64  const PeakFileOptions& getOptions() const;
65 
66 protected:
67 
70  };
71 } // namespace OpenMS
72 
A container for consensus elements.
Definition: ConsensusMap.h:66
This class provides Input functionality for ConsensusMaps and Output functionality for alignments and...
Definition: ConsensusXMLFile.h:35
void load(const String &filename, ConsensusMap &map)
Loads a consensus map from file and calls updateRanges.
const PeakFileOptions & getOptions() const
Non-mutable access to the options for loading/storing.
PeakFileOptions options_
Options that can be set.
Definition: ConsensusXMLFile.h:69
PeakFileOptions & getOptions()
Mutable access to the options for loading/storing.
~ConsensusXMLFile() override
Destructor.
ConsensusXMLFile()
Default constructor.
void store(const String &filename, const ConsensusMap &consensus_map)
Stores a consensus map to file.
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:23
Options for loading files containing peak data.
Definition: PeakFileOptions.h:22
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:27
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19