Module rosetta :: Module core :: Module pose :: Class ResidueIndexDescription

Class ResidueIndexDescription

object --+
         |
        ResidueIndexDescription

Known Subclasses:

ResidueIndexDescriptionFromFile

a class which can represent one of many ways in which to describe a particular residue in a pose, and can, when given a pose, find its index. The object should be constructed with all its needed parameters, but, one instance may be copied from another.

Instance Methods

[hide private]

__init__(*args, **kwargs)
Overloaded function.

a new object with type S, a subtype of T

__new__(T, S, ...)

assign(...)
assign(self : rosetta.core.pose.ResidueIndexDescription, : rosetta.core.pose.ResidueIndexDescription) -> rosetta.core.pose.ResidueIndexDescription

unicode

chain(rosetta.core.pose.ResidueIndexDescription)

unicode

insertion_code(rosetta.core.pose.ResidueIndexDescription)

int

pose_index(rosetta.core.pose.ResidueIndexDescription)

bool

pose_numbered(rosetta.core.pose.ResidueIndexDescription)

int

resindex(rosetta.core.pose.ResidueIndexDescription)

resolve_index(...)
resolve_index(self : rosetta.core.pose.ResidueIndexDescription, p : rosetta.core.pose.Pose) -> int

bool

unassigned(rosetta.core.pose.ResidueIndexDescription)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(*args, **kwargs)
(Constructor)

Overloaded function.

1. __init__(handle) -> NoneType

2. __init__(self : handle, pose_index : int) -> NoneType

3. __init__(handle, unicode, int) -> NoneType

doc

4. __init__(self : handle, chain : unicode, resindex : int, insertion_code : unicode) -> NoneType

5. __init__(handle, rosetta.core.pose.ResidueIndexDescription) -> NoneType

Overrides: object.__init__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

resolve_index(...)

resolve_index(self : rosetta.core.pose.ResidueIndexDescription, p : rosetta.core.pose.Pose) -> int

Turn the internal data into a pose index (in the range from 1 to total residue)
 or throw an exception if the index cannot be resolved.

Class ResidueIndexDescription

__init__(*args, **kwargs) (Constructor)

__new__(T, S, ...)

resolve_index(...)

init(*args, **kwargs)
(Constructor)

new(T, S, ...)