Skip to content
Snippets Groups Projects
Commit f23392f1 authored by BIOPZ-Haas Juergen's avatar BIOPZ-Haas Juergen
Browse files

adding docu for CreateEntityFromView

parent e1a49f49
Branches
Tags
No related merge requests found
...@@ -1537,16 +1537,31 @@ Other Entity-Related Functions ...@@ -1537,16 +1537,31 @@ Other Entity-Related Functions
.. function:: CreateViewFromAtomList(atom_list) .. function:: CreateViewFromAtomList(atom_list)
Returns a view made up of the atoms in *atom_list*. All atoms are required to Returns a view made up of the atoms in *atom_list*. All atoms are required to
be atoms of the same entity. Duplicate atoms are only added to the view once. be atoms of the same entity. Duplicate atoms are only added to the view once.
:param atom_list: the atoms :param atom_list: the atoms
:type atom_list: :class:`AtomHandleList` or :class:`AtomViewList` :type atom_list: :class:`AtomHandleList` or :class:`AtomViewList`
:raises: :class:`IntegrityError` if atoms of different entities are :raises: :class:`IntegrityError` if atoms of different entities are
encountered encountered
:returns: :class:`EntityView` :returns: :class:`EntityView`
.. function:: CreateEntityFromView(view, include_exlusive_atoms, handle)
This function behaves exactly like :meth:`EntityHandle.Copy`, except that only
atoms, residues, chains and bonds that are present in the view will be
copied.
:param view: is the view to be converted to a handle
:param include_exlusive_atoms: if true, atoms that are part of an exclusive
bond (only one bond partner is included in the view) will also be included
in the new entity handle.
:param handle: If invalid a new entity will be created. If valid, the atoms,
residues, chains, bonds and torsions will be added to handle. This is
useful to combine several entities into one.
:returns :class:`EntityHandle`
.. _chaintype: .. _chaintype:
ChainType ChainType
......
...@@ -86,7 +86,8 @@ CompareViews(const EntityView& view1, const EntityView& view2); ...@@ -86,7 +86,8 @@ CompareViews(const EntityView& view1, const EntityView& view2);
/// ///
/// \param view is the view to be converted to a handle /// \param view is the view to be converted to a handle
/// \param include_exlusive_atoms if true, atoms that are part of an exclusive /// \param include_exlusive_atoms if true, atoms that are part of an exclusive
/// bond will also be included in the new entity handle. /// bond (only one bond partner is included in the view) will also be included
/// in the new entity handle.
/// \param handle If invalid a new entity will be created. If valid, the atoms, /// \param handle If invalid a new entity will be created. If valid, the atoms,
/// residues, chains, bonds and torsions will be added to handle. This is /// residues, chains, bonds and torsions will be added to handle. This is
/// useful to combine several entities into one. /// useful to combine several entities into one.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment