Chemical Data Processing Library C++ API - Version 1.1.1
XYZMolecularGraphWriter.hpp
Go to the documentation of this file.
1 /*
2  * XYZMolecularGraphWriter.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_CHEM_XYZMOLECULARGRAPHWRITER_HPP
30 #define CDPL_CHEM_XYZMOLECULARGRAPHWRITER_HPP
31 
32 #include <memory>
33 #include <iosfwd>
34 
35 #include "CDPL/Chem/APIPrefix.hpp"
36 #include "CDPL/Base/DataWriter.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Chem
43  {
44 
45  class XYZDataWriter;
46  class MolecularGraph;
47 
49  {
50 
51  public:
57  XYZMolecularGraphWriter(std::ostream& os);
58 
63 
70 
71  operator const void*() const;
72  bool operator!() const;
73 
74  private:
76 
78 
79  typedef std::unique_ptr<XYZDataWriter> XYZDataWriterPtr;
80 
81  std::ostream& output;
82  bool state;
83  XYZDataWriterPtr writer;
84  };
85  } // namespace Chem
86 } // namespace CDPL
87 
88 #endif // CDPL_CHEM_XYZMOLECULARGRAPHWRITER_HPP
DataWriter.hpp
Definition of the class CDPL::Base::DataWriter.
APIPrefix.hpp
Definition of the preprocessor macro CDPL_CHEM_API.
CDPL_CHEM_API
#define CDPL_CHEM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL::Chem::MolecularGraph
MolecularGraph.
Definition: MolecularGraph.hpp:52
CDPL::Chem::XYZMolecularGraphWriter::~XYZMolecularGraphWriter
~XYZMolecularGraphWriter()
Destructor.
CDPL::Chem::XYZMolecularGraphWriter::write
Base::DataWriter< MolecularGraph > & write(const MolecularGraph &molgraph)
Writes data of the molecular graph molgraph to the output stream specified in the constructor.
CDPL::Chem::XYZMolecularGraphWriter
Definition: XYZMolecularGraphWriter.hpp:49
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Chem::XYZMolecularGraphWriter::operator!
bool operator!() const
CDPL::Base::DataWriter
An interface for writing data objects of a given type to an arbitrary data sink.
Definition: DataWriter.hpp:63
CDPL::Chem::XYZMolecularGraphWriter::XYZMolecularGraphWriter
XYZMolecularGraphWriter(std::ostream &os)
Constructs a XYZMolecularGraphWriter instance that will write data of molecular graphs to the output ...