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
e4f218f8
Commit
e4f218f8
authored
12 years ago
by
Bienchen
Browse files
Options
Downloads
Patches
Plain Diff
Extended documentation of AddChain() according to BZDNG-285.
parent
d8f6c1d5
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
+24
-9
24 additions, 9 deletions
modules/mol/base/doc/entity.rst
with
24 additions
and
9 deletions
modules/mol/base/doc/entity.rst
+
24
−
9
View file @
e4f218f8
...
...
@@ -856,19 +856,35 @@ The View Classes
Returns a copy of this entity. Provided for `duck-typing <http://en.wikipedia.org/wiki/Duck_typing>` purposes.
:rtype: EntityView
:rtype:
:class:`
EntityView
`
.. method:: AddChain(chain_handle[, view_add_flags])
Add chain to view. By default, only the chain is added to the view, but not
its residues and atoms. This behavior can be changed by passing in an
appropriate set of `view_add_flags`
its residues and atoms. This behaviour can be changed by passing in an
appropriate set of `view_add_flags`.
The following example just adds a chain without residues and atoms:
.. code-block:: python
pdb = ost.io.LoadPDB(<PDB file name>)
v = pdb.CreateEmptyView()
v.AddChain(pdb.chains[0])
To **copy** a whole chain, go like:
.. code-block:: python
pdb = ost.io.LoadPDB(<PDB file name>)
v = pdb.CreateEmptyView()
v.AddChain(pdb.chains[0], ost.mol.INCLUDE_ALL)
:param chain_handle:
:type chain_handle: ChainHandle
:param view_add_flags: An ORed together combination of `view_add_flags`.
:type view_add_flags: int
:rtype: class:`ChainView`
:type view_add_flags:
:class:`
int
`
:rtype:
:
class:`ChainView`
.. method:: AddResidue(residue_handle[, view_add_flags])
...
...
@@ -881,7 +897,7 @@ The View Classes
:type residue_handle: ResidueHandle
:param view_add_flags:
:type view_add_flags: int
:rtype: class:`ResidueView`
:rtype:
:
class:`ResidueView`
.. method:: AddAtom(atom_handle[, view_add_flags])
...
...
@@ -1617,4 +1633,3 @@ ChainType functions
:raises: :class:`runtime_error` if **type** is unrecognised.
:returns: :class:`str`
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