OpenStructure
mmcif_str.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_MMCIF_STR_HH
20 #define OST_IO_MMCIF_STR_HH
21 
22 #include <ost/io/module_config.hh>
23 #include <ost/io/io_exception.hh>
24 #include <ost/mol/entity_handle.hh>
25 #include <ost/io/mmcif_reader.hh>
26 #include <ost/io/mol/io_profile.hh>
27 #include <ost/io/mmcif_writer.hh>
28 #include <ost/io/mol/omf.hh>
29 
30 namespace ost { namespace io {
31 
33 EntityToMMCifString(const ost::mol::EntityHandle& ent, const String& data_name,
34  ost::conop::CompoundLibPtr compound_lib, bool mmcif_conform,
35  const std::vector<MMCifWriterEntity>& entity_info = std::vector<MMCifWriterEntity>());
36 
38 EntityToMMCifString(const ost::mol::EntityView& ent, const String& data_name,
39  ost::conop::CompoundLibPtr compound_lib, bool mmcif_conform,
40  const std::vector<MMCifWriterEntity>& entity_info = std::vector<MMCifWriterEntity>());
41 
43 OMFToMMCifString(const ost::io::OMF& omf, const String& data_name,
44  ost::conop::CompoundLibPtr compound_lib, bool mmcif_conform,
45  const std::vector<MMCifWriterEntity>& entity_info = std::vector<MMCifWriterEntity>());
46 
47 std::tuple<mol::EntityHandle, MMCifInfo, ost::seq::SequenceList> DLLEXPORT_OST_IO
48 MMCifStringToEntity(const String& mmcif, const IOProfile& profile, bool process);
49 
50 }}
51 
52 #endif
Protein or molecule.
definition of EntityView
Definition: entity_view.hh:86
#define DLLEXPORT_OST_IO
std::string String
Definition: base.hh:54
boost::shared_ptr< CompoundLib > CompoundLibPtr
Definition: compound_lib.hh:32
String DLLEXPORT_OST_IO EntityToMMCifString(const ost::mol::EntityHandle &ent, const String &data_name, ost::conop::CompoundLibPtr compound_lib, bool mmcif_conform, const std::vector< MMCifWriterEntity > &entity_info=std::vector< MMCifWriterEntity >())
String DLLEXPORT_OST_IO OMFToMMCifString(const ost::io::OMF &omf, const String &data_name, ost::conop::CompoundLibPtr compound_lib, bool mmcif_conform, const std::vector< MMCifWriterEntity > &entity_info=std::vector< MMCifWriterEntity >())
std::tuple< mol::EntityHandle, MMCifInfo, ost::seq::SequenceList > DLLEXPORT_OST_IO MMCifStringToEntity(const String &mmcif, const IOProfile &profile, bool process)
Definition: base.dox:1