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
8b581de8
Unverified
Commit
8b581de8
authored
1 year ago
by
Xavier Robin
Browse files
Options
Downloads
Patches
Plain Diff
doc: add ViewForHandle
parent
23e4d4cb
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/mol/base/doc/entity.rst
+48
-3
48 additions, 3 deletions
modules/mol/base/doc/entity.rst
with
48 additions
and
3 deletions
modules/mol/base/doc/entity.rst
+
48
−
3
View file @
8b581de8
...
...
@@ -1600,11 +1600,24 @@ The View Classes
.. method:: FindResidue(residue)
Find residue view of pointing to the given handle
.
Deprecated. Use :meth:`ViewForHandle` instead
.
:param residue: Residue handle
:type residue: ResidueHandle
:returns: The residue view pointing the the handle, or an invalid handle if the residue is not part of the view
:returns: The residue view pointing the handle, or an invalid handle if the residue is not part of the view
:rtype: :class:`ResidueView`
.. method:: FindResidue(chain_name, res_num)
:noindex:
Find residue by chain name and residue number.
:param chain_name: Chain identifier, e.g. "A"
:type chain_name: str
:param res_num: residue number
:type res_num: :class:`ResNum`
:returns: The residue if present in the view, an invalid :class:`ResidueView`
otherwise
:rtype: :class:`ResidueView`
.. method:: FindAtom(chain_name, res_num, atom_name)
...
...
@@ -1615,8 +1628,20 @@ The View Classes
:type res_num: :class:`ResNum` or :class:`int`
:param atom_name: The name of the atom
:type atom_name: str
:returns: The atom if present in the view, an invalid :class:`AtomView`
otherwise
:rtype: :class:`AtomView`
.. method:: ViewForHandle(handle)
Find chain view, residue view or atom view of pointing to the given handle.
:param handle: handle to search for
:type residue: (Chain\|Residue\|Atom)Handle
:returns: The view pointing the handle, or an invalid handle if the handle
is not part of the view
:rtype: (Chain\|Residue\|Atom)View
.. method:: Select(query, flags=0)
Perform selection on entity view. See :meth:`EntityHandle.Select`.
...
...
@@ -1877,6 +1902,16 @@ The View Classes
:returns: The residue view, or an invalid residue view if no residue with
the given residue number is in the view.
.. method:: ViewForHandle(handle)
Find residue view or atom view of pointing to the given handle.
:param handle: handle to search for
:type residue: (Residue\|Atom)Handle
:returns: The view pointing the handle, or an invalid handle if the handle
is not part of the view
:rtype: (Residue\|Atom)View
.. method:: GetCenterOfAtoms()
See :attr:`center_of_atoms`
...
...
@@ -2036,6 +2071,16 @@ The View Classes
:type atom_view: :class:`AtomView`
:rtype: None
.. method:: ViewForHandle(handle)
Find atom view of pointing to the given handle.
:param handle: handle to search for
:type residue: :class:`AtomHandle`
:returns: The view pointing the handle, or an invalid handle if the handle
is not part of the view
:rtype: :class:`AtomView`
.. method:: GetHandle()
See :attr:`handle`
...
...
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