Chemical Data Processing Library C++ API - Version 1.4.0
PMLFeatureContainerWriter.hpp
Go to the documentation of this file.
1 /*
2  * PMLFeatureContainerWriter.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_PHARM_PMLFEATURECONTAINERWRITER_HPP
30 #define CDPL_PHARM_PMLFEATURECONTAINERWRITER_HPP
31 
32 #include <memory>
33 #include <iosfwd>
34 
35 #include "CDPL/Pharm/APIPrefix.hpp"
36 #include "CDPL/Base/DataWriter.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Pharm
43  {
44 
45  class PMLDataWriter;
46  class FeatureContainer;
47 
52  {
53 
54  public:
60  PMLFeatureContainerWriter(std::ostream& os);
61 
63 
68 
70 
77 
81  void close();
82 
87  operator const void*() const;
88 
93  bool operator!() const;
94 
95  private:
96  typedef std::unique_ptr<PMLDataWriter> PMLDataWriterPtr;
97 
98  std::ostream& output;
99  bool state;
100  PMLDataWriterPtr writer;
101  };
102  } // namespace Pharm
103 } // namespace CDPL
104 
105 #endif // CDPL_PHARM_PMLFEATURECONTAINERWRITER_HPP
Definition of class CDPL::Base::DataWriter.
Definition of the preprocessor macro CDPL_PHARM_API.
#define CDPL_PHARM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Interface for writing data objects of a given type to an arbitrary data sink.
Definition: DataWriter.hpp:63
Abstract base class for containers holding a sequence of Pharm::Feature objects with associated prope...
Definition: FeatureContainer.hpp:55
Writer for feature container data in the native I/O format of LigandScout.
Definition: PMLFeatureContainerWriter.hpp:52
PMLFeatureContainerWriter & operator=(const PMLFeatureContainerWriter &)=delete
PMLFeatureContainerWriter(std::ostream &os)
Constructs a PMLFeatureContainerWriter instance that will write data of feature containers to the out...
bool operator!() const
Tells whether the writer is in a bad (non-writable) state.
Base::DataWriter< FeatureContainer > & write(const FeatureContainer &cntnr)
Writes data of the feature container cntnr to the output stream specified in the constructor.
void close()
Finalizes the PML output and flushes the underlying stream.
PMLFeatureContainerWriter(const PMLFeatureContainerWriter &)=delete
The namespace of the Chemical Data Processing Library.