OpenMS
FeatureXMLFile.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Chris Bielow $
6 // $Authors: Marc Sturm, Chris Bielow, Clemens Groepl $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 #include <OpenMS/FORMAT/XMLFile.h>
14 
15 #include <iosfwd>
16 
17 namespace OpenMS
18 {
19  class Feature;
20  class FeatureMap;
21 
36  class OPENMS_DLLAPI FeatureXMLFile :
37  public Internal::XMLFile,
38  public ProgressLogger
39  {
40 
41 public:
42 
48  ~FeatureXMLFile() override;
50 
57  void load(const String& filename, FeatureMap& feature_map);
58 
59  Size loadSize(const String& filename);
60 
66  void store(const String& filename, const FeatureMap& feature_map);
67 
70 
73 
76 
77 protected:
78 
81 
82  };
83 
84 } // namespace OpenMS
85 
Options for loading files containing features.
Definition: FeatureFileOptions.h:21
A container for features.
Definition: FeatureMap.h:80
This class provides Input/Output functionality for feature maps.
Definition: FeatureXMLFile.h:39
FeatureXMLFile()
Default constructor.
const FeatureFileOptions & getOptions() const
Non-mutable access to the options for loading/storing.
void load(const String &filename, FeatureMap &feature_map)
loads the file with name filename into map and calls updateRanges().
void store(const String &filename, const FeatureMap &feature_map)
stores the map feature_map in file with name filename.
~FeatureXMLFile() override
Destructor.
FeatureFileOptions options_
Options that can be set.
Definition: FeatureXMLFile.h:80
Size loadSize(const String &filename)
FeatureFileOptions & getOptions()
Mutable access to the options for loading/storing.
void setOptions(const FeatureFileOptions &)
setter for options for loading/storing
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
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:101
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22