Chemical Data Processing Library C++ API - Version 1.1.1
PDBMoleculeReader.hpp
Go to the documentation of this file.
1 /*
2  * PDBMoleculeReader.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_BIOMOL_PDBMOLECULEREADER_HPP
30 #define CDPL_BIOMOL_PDBMOLECULEREADER_HPP
31 
32 #include <memory>
33 
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Chem
42  {
43 
44  class Molecule;
45  }
46 
47  namespace Biomol
48  {
49 
50  class PDBDataReader;
51 
56  class CDPL_BIOMOL_API PDBMoleculeReader : public Util::StreamDataReader<Chem::Molecule, PDBMoleculeReader>
57  {
58 
59  public:
65  PDBMoleculeReader(std::istream& is);
66 
71 
72  private:
73  friend class Util::StreamDataReader<Chem::Molecule, PDBMoleculeReader>;
74 
75  PDBMoleculeReader(const PDBMoleculeReader&);
76 
77  PDBMoleculeReader& operator=(const PDBMoleculeReader&);
78 
79  bool readData(std::istream&, Chem::Molecule&, bool overwrite);
80  bool skipData(std::istream&);
81  bool moreData(std::istream&);
82 
83  typedef std::unique_ptr<PDBDataReader> PDBDataReaderPtr;
84 
85  PDBDataReaderPtr reader;
86  };
87  } // namespace Biomol
88 } // namespace CDPL
89 
90 #endif // CDPL_BIOMOL_PDBMOLECULEREADER_HPP
CDPL::Biomol::PDBMoleculeReader::PDBMoleculeReader
PDBMoleculeReader(std::istream &is)
Constructs a PDBMoleculeReader instance that will read the molecule data from the input stream is.
bool
CDPL::Biomol::PDBMoleculeReader::~PDBMoleculeReader
~PDBMoleculeReader()
Destructor.
CDPL::Biomol::PDBMoleculeReader
A reader for molecule data in the Brookhaven Protein Data Bank (PDB) [PDB] format.
Definition: PDBMoleculeReader.hpp:57
APIPrefix.hpp
Definition of the preprocessor macro CDPL_BIOMOL_API.
CDPL
The namespace of the Chemical Data Processing Library.
StreamDataReader.hpp
Definition of the class CDPL::Util::StreamDataReader.
CDPL_BIOMOL_API
#define CDPL_BIOMOL_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL::Util::StreamDataReader
A helper class that implements Base::DataReader for std::istream based data readers.
Definition: StreamDataReader.hpp:73