Chemical Data Processing Library C++ API - Version 1.2.0
DataInputHandler.hpp
Go to the documentation of this file.
1 /*
2  * DataInputHandler.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_BASE_DATAINPUTHANDLER_HPP
30 #define CDPL_BASE_DATAINPUTHANDLER_HPP
31 
32 #include <ios>
33 #include <string>
34 #include <memory>
35 
36 #include "CDPL/Base/DataReader.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Base
43  {
44 
45  class DataFormat;
46 
52  template <typename T>
54  {
55 
56  public:
58 
59  typedef std::shared_ptr<DataInputHandler> SharedPointer;
60 
64  virtual ~DataInputHandler() {}
65 
70  virtual const DataFormat& getDataFormat() const = 0;
71 
77  virtual typename ReaderType::SharedPointer createReader(std::istream& is) const = 0;
78 
85  virtual typename ReaderType::SharedPointer createReader(const std::string& file_name,
86  std::ios_base::openmode mode = std::ios_base::in | std::ios_base::binary) const = 0;
87  };
88  } // namespace Base
89 } // namespace CDPL
90 
91 #endif // CDPL_BASE_DATAINPUTHANDLER_HPP
Definition of the class CDPL::Base::DataReader.
Provides meta-information about a particular data storage format.
Definition: Base/DataFormat.hpp:49
A factory interface providing methods for the creation of Base::DataReader instances handling a parti...
Definition: DataInputHandler.hpp:54
std::shared_ptr< DataInputHandler > SharedPointer
Definition: DataInputHandler.hpp:59
virtual const DataFormat & getDataFormat() const =0
Returns a Base::DataFormat object that provides information about the handled input data format.
virtual ReaderType::SharedPointer createReader(const std::string &file_name, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::binary) const =0
Creates a Base::DataReader instance that will read the data from the file specified by file_name.
virtual ReaderType::SharedPointer createReader(std::istream &is) const =0
Creates a Base::DataReader instance that will read the data from the input stream is.
virtual ~DataInputHandler()
Virtual destructor.
Definition: DataInputHandler.hpp:64
DataReader< T > ReaderType
Definition: DataInputHandler.hpp:57
An interface for reading data objects of a given type from an arbitrary data source.
Definition: DataReader.hpp:73
std::shared_ptr< DataReader > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated DataReader instances.
Definition: DataReader.hpp:84
The namespace of the Chemical Data Processing Library.