OpenStructure
entity_io_mmcif_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_MMCIF_HH
20 #define OST_IO_ENTITY_IO_PLUGIN_MMCIF_HH
21 
22 #include <vector>
23 
25 
26 namespace ost { namespace io {
27 
28 
30 public:
31  virtual void Import(mol::EntityHandle& ent,
32  const boost::filesystem::path& loc);
33 
34  virtual void Export(const mol::EntityView& ent,
35  const boost::filesystem::path& loc) const;
36 
37  virtual void Import(mol::EntityHandle& ent, std::istream& stream);
38 
39  virtual void Export(const mol::EntityView& ent, std::ostream& stream) const;
40 
41  static bool ProvidesImport(const boost::filesystem::path& loc,
42  const String& format="auto");
43  static bool ProvidesExport(const boost::filesystem::path& loc,
44  const String& format="auto");
45  virtual bool RequiresProcessor() const;
46 
47  static String GetFormatName() { return String("mmCIF"); }
49  return String("macromolecular Crystallographic Information File ");
50  }
51 };
52 
53 
55 
56 
57 }} // ns
58 
59 #endif
pure abstract base class for entity io handlers
static bool ProvidesImport(const boost::filesystem::path &loc, const String &format="auto")
static bool ProvidesExport(const boost::filesystem::path &loc, const String &format="auto")
virtual void Export(const mol::EntityView &ent, const boost::filesystem::path &loc) const
virtual void Import(mol::EntityHandle &ent, const boost::filesystem::path &loc)
virtual void Export(const mol::EntityView &ent, std::ostream &stream) const
virtual bool RequiresProcessor() const
virtual void Import(mol::EntityHandle &ent, std::istream &stream)
Protein or molecule.
definition of EntityView
Definition: entity_view.hh:86
#define DLLEXPORT_OST_IO
std::string String
Definition: base.hh:54
EntityIOHandlerFactory< EntityIOMMCIFHandler > EntityIOMMCIFHandlerFactory
Definition: base.dox:1