Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openstructure
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
openstructure
Commits
f23392f1
Commit
f23392f1
authored
12 years ago
by
BIOPZ-Haas Juergen
Browse files
Options
Downloads
Patches
Plain Diff
adding docu for CreateEntityFromView
parent
e1a49f49
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
modules/mol/base/doc/entity.rst
+24
-9
24 additions, 9 deletions
modules/mol/base/doc/entity.rst
modules/mol/base/src/view_op.hh
+2
-1
2 additions, 1 deletion
modules/mol/base/src/view_op.hh
with
26 additions
and
10 deletions
modules/mol/base/doc/entity.rst
+
24
−
9
View file @
f23392f1
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
modules/mol/base/src/view_op.hh
+
2
−
1
View file @
f23392f1
...
...
@@ -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.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment