OpenStructure
build-2.8-doc
stage
include
ost
io
mol
pdb_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_PDB_STR_HH
20
#define OST_IO_PDB_STR_HH
21
22
#include <
ost/io/module_config.hh
>
23
#include <
ost/mol/entity_view.hh
>
24
#include <
ost/mol/entity_handle.hh
>
25
#include <
ost/io/mol/io_profile.hh
>
26
27
namespace
ost
{
namespace
io {
28
29
// Saves an entity to a string in PDB format.
30
String
DLLEXPORT_OST_IO
31
EntityToPDBString
(
const
mol::EntityHandle
& ent,
const
IOProfile
& profile=
IOProfile
());
32
33
String
DLLEXPORT_OST_IO
34
EntityToPDBString
(
const
mol::EntityView
& ent,
const
IOProfile
& profile=
IOProfile
());
35
36
mol::EntityHandle
DLLEXPORT_OST_IO
37
PDBStringToEntity
(
const
String
& pdb,
const
IOProfile
& profile=
IOProfile
(),
38
bool
process=
false
);
39
40
}}
41
42
#endif
ost::mol::EntityHandle
Protein or molecule.
Definition:
entity_handle.hh:54
ost::mol::EntityView
definition of EntityView
Definition:
entity_view.hh:86
entity_handle.hh
entity_view.hh
module_config.hh
DLLEXPORT_OST_IO
#define DLLEXPORT_OST_IO
Definition:
module_config.hh:27
String
std::string String
Definition:
base.hh:54
io_profile.hh
ost::io::EntityToPDBString
String DLLEXPORT_OST_IO EntityToPDBString(const mol::EntityHandle &ent, const IOProfile &profile=IOProfile())
ost::io::PDBStringToEntity
mol::EntityHandle DLLEXPORT_OST_IO PDBStringToEntity(const String &pdb, const IOProfile &profile=IOProfile(), bool process=false)
ost
Definition:
base.dox:1
ost::io::IOProfile
Definition:
io_profile.hh:31
Generated by
1.9.1