Skip to content
Snippets Groups Projects
Verified Commit fb2e12f7 authored by Xavier Robin's avatar Xavier Robin
Browse files

doc: link to generic properties

parent 5eb63c61
No related branches found
No related tags found
No related merge requests found
...@@ -8,6 +8,10 @@ This document describes the :class:`EntityHandle` and the related classes. ...@@ -8,6 +8,10 @@ This document describes the :class:`EntityHandle` and the related classes.
The Handle Classes The Handle Classes
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
:class:`Entity <EntityHandle>`, :class:`residue <ResidueHandle>`,
:class:`atom <AtomHandle>` and :class:`bond <BondHandle>` handles can store
arbitrary :doc:`generic properties <../../base/generic>`.
.. function:: CreateEntity() .. function:: CreateEntity()
Creates a new entity. The created entity is empty, that is, it does not Creates a new entity. The created entity is empty, that is, it does not
...@@ -30,6 +34,10 @@ Entity Handle ...@@ -30,6 +34,10 @@ Entity Handle
represent a ligand or a collection of water molecules - hence the rather represent a ligand or a collection of water molecules - hence the rather
generic name. generic name.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: chains .. attribute:: chains
List of all chains of this entity. The chains are in the same List of all chains of this entity. The chains are in the same
...@@ -350,6 +358,10 @@ Chain Handle ...@@ -350,6 +358,10 @@ Chain Handle
A chain of one or more :class:`residues <ResidueHandle>`. Chains are always A chain of one or more :class:`residues <ResidueHandle>`. Chains are always
part of an entity. part of an entity.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: atoms .. attribute:: atoms
Get list of all atoms of this chain. To access a single atom, use Get list of all atoms of this chain. To access a single atom, use
...@@ -593,6 +605,10 @@ Residue Handle ...@@ -593,6 +605,10 @@ Residue Handle
more :class:`atoms <AtomHandle>`. Residues are always part of a more :class:`atoms <AtomHandle>`. Residues are always part of a
:class:`ChainHandle`, even if they are ligands or water molecules where the :class:`ChainHandle`, even if they are ligands or water molecules where the
concept of a chain does not apply. concept of a chain does not apply.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: name .. attribute:: name
...@@ -1026,6 +1042,10 @@ Atom Handle ...@@ -1026,6 +1042,10 @@ Atom Handle
Represents an atom in a molecular structure. Atoms are always part of a Represents an atom in a molecular structure. Atoms are always part of a
residue. residue.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: name .. attribute:: name
...@@ -1269,6 +1289,10 @@ Bond Handle ...@@ -1269,6 +1289,10 @@ Bond Handle
Represents a chemical bond between two atoms (first and second). Represents a chemical bond between two atoms (first and second).
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: first .. attribute:: first
.. attribute:: second .. attribute:: second
...@@ -1367,6 +1391,10 @@ Bond Handle ...@@ -1367,6 +1391,10 @@ Bond Handle
The View Classes The View Classes
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
:class:`Entity <EntityView>`, :class:`residue <ResidueView>` and
:class:`atom <AtomView>` views can store arbitrary
:doc:`generic properties <../../base/generic>`.
Entity View Entity View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
...@@ -1377,6 +1405,10 @@ Entity View ...@@ -1377,6 +1405,10 @@ Entity View
:class:`BondHandle`\s. :class:`BondHandle`\s.
For an introduction, see :doc:`../../intro-01`. For an introduction, see :doc:`../../intro-01`.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: handle .. attribute:: handle
The underlying :class:`handle <EntityHandle>` of the entity view. Also The underlying :class:`handle <EntityHandle>` of the entity view. Also
...@@ -1795,6 +1827,10 @@ Chain View ...@@ -1795,6 +1827,10 @@ Chain View
A view representation of a :class:`ChainHandle`. Mostly, the same A view representation of a :class:`ChainHandle`. Mostly, the same
functionality is provided as for the handle. functionality is provided as for the handle.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: handle .. attribute:: handle
The chain handle this view points to. Also available as :meth:`GetHandle`. The chain handle this view points to. Also available as :meth:`GetHandle`.
...@@ -2043,6 +2079,10 @@ Residue View ...@@ -2043,6 +2079,10 @@ Residue View
A view representation of a :class:`ResidueHandle`. Mostly, the same A view representation of a :class:`ResidueHandle`. Mostly, the same
functionality is provided as for the handle. functionality is provided as for the handle.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: handle .. attribute:: handle
The residue handle this view points to. Also available as The residue handle this view points to. Also available as
...@@ -2229,6 +2269,10 @@ Atom View ...@@ -2229,6 +2269,10 @@ Atom View
A view representation of an :class:`AtomHandle`. Mostly, the same A view representation of an :class:`AtomHandle`. Mostly, the same
functionality is provided as for the handle. functionality is provided as for the handle.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. attribute:: handle .. attribute:: handle
The underlying :class:`AtomHandle` of the atom view. Also available as The underlying :class:`AtomHandle` of the atom view. Also available as
......
...@@ -83,6 +83,10 @@ The SequenceHandle ...@@ -83,6 +83,10 @@ The SequenceHandle
ConstSequenceHandle ConstSequenceHandle
Represents a sequence. New instances are created with :func:`CreateSequence`. Represents a sequence. New instances are created with :func:`CreateSequence`.
.. attribute:: properties
All the :class:`generic properties <ost.GenericPropContainer>` are available.
.. method:: GetPos(residue_index) .. method:: GetPos(residue_index)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment