OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
entity_io_pdb_handler.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of the OpenStructure project <www.openstructure.org>
3 //
4 // Copyright (C) 2008-2020 by the OpenStructure authors
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License as published by the Free
8 // Software Foundation; either version 3.0 of the License, or (at your option)
9 // any later version.
10 // This library is distributed in the hope that it will be useful, but WITHOUT
11 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 // details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library; if not, write to the Free Software Foundation, Inc.,
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //------------------------------------------------------------------------------
19 #ifndef OST_IO_ENTITY_IO_PLUGIN_PDB_H
20 #define OST_IO_ENTITY_IO_PLUGIN_PDB_H
21 
22 /*
23  Authors: Ansgar Philippsen, Marco Biasini
24  */
25 #include <vector>
26 
28 
29 namespace ost { namespace io {
30 
31 
33 public:
34  virtual void Import(mol::EntityHandle& ent,
35  const boost::filesystem::path& loc);
36 
37  virtual void Export(const mol::EntityView& ent,
38  const boost::filesystem::path& loc) const;
39 
40  virtual void Import(mol::EntityHandle& ent, std::istream& stream);
41 
42  virtual void Export(const mol::EntityView& ent, std::ostream& stream) const;
43 
44  static bool ProvidesImport(const boost::filesystem::path& loc,
45  const String& format="auto");
46  static bool ProvidesExport(const boost::filesystem::path& loc,
47  const String& format="auto");
48  virtual bool RequiresProcessor() const;
49 
50  static String GetFormatName() { return String("Pdb"); }
51  static String GetFormatDescription() { return String("Protein Data Bank file format"); }
52 };
53 
54 
56 
57 
58 }} // ns
59 
60 #endif
EntityIOHandlerFactory< EntityIOPDBHandler > EntityIOPDBHandlerFactory
std::string String
Definition: base.hh:54
Protein or molecule.
#define DLLEXPORT_OST_IO
definition of EntityView
Definition: entity_view.hh:86
pure abstract base class for entity io handlers