OpenMS  3.0.0
OMSFile.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-2022.
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: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 namespace OpenMS
42 {
48  class OPENMS_DLLAPI OMSFile: public ProgressLogger
49  {
50  public:
52  explicit OMSFile(LogType log_type = LogType::NONE):
53  log_type_(log_type)
54  {
55  setLogType(log_type);
56  }
57 
63  void store(const String& filename, const IdentificationData& id_data);
64 
70  void store(const String& filename, const FeatureMap& features);
71 
77  void load(const String& filename, IdentificationData& id_data);
78 
84  void load(const String& filename, FeatureMap& features);
85 
86  protected:
88  };
89 } // namespace OpenMS
90 
OpenMS::OMSFile
This class supports reading and writing of OMS files.
Definition: OMSFile.h:48
OpenMS::DriftTimeUnit::NONE
No unit.
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:52
ProgressLogger.h
FeatureMap.h
OpenMS::OMSFile::OMSFile
OMSFile(LogType log_type=LogType::NONE)
Constructor (with option to set log type)
Definition: OMSFile.h:52
OpenMS::OMSFile::log_type_
LogType log_type_
Definition: OMSFile.h:87
OpenMS::ProgressLogger::LogType
LogType
Possible log types.
Definition: ProgressLogger.h:68
OpenMS::IdentificationData
Representation of spectrum identification results and associated data.
Definition: IdentificationData.h:94
OpenMS::FeatureMap
A container for features.
Definition: FeatureMap.h:98
IdentificationData.h