Chemical Data Processing Library C++ API - Version 1.1.1
DataOutputHandler.hpp
Go to the documentation of this file.
1 /*
2  * DataOutputHandler.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_DATAOUTPUTHANDLER_HPP
30 #define CDPL_BASE_DATAOUTPUTHANDLER_HPP
31 
32 #include <ios>
33 #include <memory>
34 
35 #include "CDPL/Base/DataWriter.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Base
42  {
43 
44  class DataFormat;
45 
51  template <typename T>
53  {
54 
55  public:
57 
58  typedef std::shared_ptr<DataOutputHandler> SharedPointer;
59 
63  virtual ~DataOutputHandler() {}
64 
69  virtual const DataFormat& getDataFormat() const = 0;
70 
76  virtual typename WriterType::SharedPointer createWriter(std::iostream& ios) const = 0;
77 
84  virtual typename WriterType::SharedPointer createWriter(const std::string& file_name,
85  std::ios_base::openmode mode = std::ios_base::in |
86  std::ios_base::out | std::ios_base::trunc | std::ios_base::binary) const = 0;
87  };
88  } // namespace Base
89 } // namespace CDPL
90 
91 #endif // CDPL_BASE_DATAOUTPUTHANDLER_HPP
CDPL::Base::DataFormat
Provides meta-information about a particular data storage format.
Definition: Base/DataFormat.hpp:49
DataWriter.hpp
Definition of the class CDPL::Base::DataWriter.
CDPL::Base::DataOutputHandler::SharedPointer
std::shared_ptr< DataOutputHandler > SharedPointer
Definition: DataOutputHandler.hpp:58
CDPL::Base::DataOutputHandler
A factory interface providing methods for the creation of Base::DataWriter instances handling a parti...
Definition: DataOutputHandler.hpp:53
CDPL::Base::DataOutputHandler::~DataOutputHandler
virtual ~DataOutputHandler()
Virtual destructor.
Definition: DataOutputHandler.hpp:63
CDPL::Base::DataOutputHandler::createWriter
virtual WriterType::SharedPointer createWriter(std::iostream &ios) const =0
Creates a Base::DataWriter instance that will write the data to the I/O stream ios.
CDPL::Base::DataWriter< Chem::MolecularGraph >::SharedPointer
std::shared_ptr< DataWriter > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated DataWriter instances.
Definition: DataWriter.hpp:69
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Base::DataWriter
An interface for writing data objects of a given type to an arbitrary data sink.
Definition: DataWriter.hpp:63
CDPL::Base::DataOutputHandler::createWriter
virtual WriterType::SharedPointer createWriter(const std::string &file_name, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::trunc|std::ios_base::binary) const =0
Creates a Base::DataWriter instance that will write the data to the file specified by file_name.
CDPL::Base::DataOutputHandler::getDataFormat
virtual const DataFormat & getDataFormat() const =0
Returns a Base::DataFormat object that provides information about the handled output data format.
CDPL::Base::DataOutputHandler::WriterType
DataWriter< T > WriterType
Definition: DataOutputHandler.hpp:56