diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst index 08008da21f142ef3ffae33cb3ffea47823617f8f..f64acce8d0429e574c2f723c997d0e0def0be195 100644 --- a/modules/mol/base/doc/entity.rst +++ b/modules/mol/base/doc/entity.rst @@ -1537,16 +1537,31 @@ Other Entity-Related Functions .. function:: CreateViewFromAtomList(atom_list) - 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. - - :param atom_list: the atoms - :type atom_list: :class:`AtomHandleList` or :class:`AtomViewList` - :raises: :class:`IntegrityError` if atoms of different entities are - encountered - - :returns: :class:`EntityView` + 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. + + :param atom_list: the atoms + :type atom_list: :class:`AtomHandleList` or :class:`AtomViewList` + :raises: :class:`IntegrityError` if atoms of different entities are + encountered + + :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 diff --git a/modules/mol/base/src/view_op.hh b/modules/mol/base/src/view_op.hh index b673f160c30ef63e0c9ea46ce3f78b3bce160262..1774b289dc7689166f075500f2ee3c96026e3a35 100644 --- a/modules/mol/base/src/view_op.hh +++ b/modules/mol/base/src/view_op.hh @@ -86,7 +86,8 @@ CompareViews(const EntityView& view1, const EntityView& view2); /// /// \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 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, /// residues, chains, bonds and torsions will be added to handle. This is /// useful to combine several entities into one.