OpenMS  3.0.0
IMSAlphabetParser.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: Timo Sachsenberg $
32 // $Authors: Anton Pervukhin <Anton.Pervukhin@CeBiTec.Uni-Bielefeld.DE> $
33 // --------------------------------------------------------------------------
34 //
35 
36 #pragma once
37 
38 #include <fstream>
39 #include <istream>
40 #include <map>
41 #include <string>
42 
44 
45 namespace OpenMS
46 {
47 
48  namespace ims
49  {
50 
60  template <typename AlphabetElementType = double,
61  typename Container = std::map<std::string, AlphabetElementType>,
62  typename InputSource = std::istream>
64  {
65 public:
69  typedef Container ContainerType;
70 
78  void load(const std::string & fname);
79 
85  virtual ContainerType & getElements() = 0;
86 
92  virtual void parse(InputSource & is) = 0;
93 
95  virtual ~IMSAlphabetParser() {}
96  };
97 
98  template <typename AlphabetElementType, typename Container, typename InputSource>
100  {
101  std::ifstream ifs(fname.c_str());
102  if (!ifs)
103  {
104  throw Exception::IOException(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, fname);
105  }
106  this->parse(ifs);
107  }
108 
109  } // namespace ims
110 } // namespace OpenMS
111 
double
OpenMS::ims::IMSAlphabetParser::ContainerType
Container ContainerType
Definition: IMSAlphabetParser.h:69
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
OpenMS::Exception::IOException
General IOException.
Definition: Exception.h:566
OpenMS::ims::IMSAlphabetParser::load
void load(const std::string &fname)
Definition: IMSAlphabetParser.h:99
OpenMS::ims::IMSAlphabetParser::~IMSAlphabetParser
virtual ~IMSAlphabetParser()
Destructor.
Definition: IMSAlphabetParser.h:95
OpenMS::ims::IMSAlphabetParser::getElements
virtual ContainerType & getElements()=0
OpenMS::ims::IMSAlphabetParser
An abstract templatized parser to load the data that is used to initialize Alphabet objects.
Definition: IMSAlphabetParser.h:63
OpenMS::ims::IMSAlphabetParser::parse
virtual void parse(InputSource &is)=0