stage/include/ost/io/entity_io_sdf_handler.hh
Go to the documentation of this file.00001 //------------------------------------------------------------------------------ 00002 // This file is part of the OpenStructure project <www.openstructure.org> 00003 // 00004 // Copyright (C) 2008-2011 by the OpenStructure authors 00005 // 00006 // This library is free software; you can redistribute it and/or modify it under 00007 // the terms of the GNU Lesser General Public License as published by the Free 00008 // Software Foundation; either version 3.0 of the License, or (at your option) 00009 // any later version. 00010 // This library is distributed in the hope that it will be useful, but WITHOUT 00011 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00012 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 00013 // details. 00014 // 00015 // You should have received a copy of the GNU Lesser General Public License 00016 // along with this library; if not, write to the Free Software Foundation, Inc., 00017 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 00018 //------------------------------------------------------------------------------ 00019 #ifndef OST_IO_ENTITY_IO_PLUGIN_SDF_H 00020 #define OST_IO_ENTITY_IO_PLUGIN_SDF_H 00021 00022 #include <ost/io/mol/entity_io_handler.hh> 00023 00024 namespace ost { namespace io { 00025 00026 class DLLEXPORT_OST_IO EntityIOSDFHandler: public EntityIOHandler { 00027 public: 00028 virtual void Import(mol::EntityHandle& ent, 00029 const boost::filesystem::path& loc); 00030 virtual void Export(const mol::EntityView& ent, 00031 const boost::filesystem::path& loc) const; 00032 // import data from provided stream 00033 virtual void Import(mol::EntityHandle& ent, 00034 std::istream& stream); 00035 // export data from entity view to provided stream 00036 virtual void Export(const mol::EntityView& ent, 00037 std::ostream& stream) const; 00038 static bool ProvidesImport(const boost::filesystem::path& loc, 00039 const String& format="auto"); 00040 static bool ProvidesExport(const boost::filesystem::path& loc, 00041 const String& format="auto"); 00042 00043 virtual bool RequiresProcessor() const; 00044 00045 static String GetFormatName() { return String("Sdf"); } 00046 static String GetFormatDescription() { return String("Structure-data format from Molecular Design Limited"); } 00047 }; 00048 00049 typedef EntityIOHandlerFactory<EntityIOSDFHandler> EntityIOSDFHandlerFactory; 00050 00051 mol::EntityHandle DLLEXPORT_OST_IO LoadSDF(const String& file_name); 00052 00053 }} // ns 00054 00055 #endif
