IMP  2.0.0
The Integrative Modeling Platform
IMP.restrainer.Restraint Class Reference

Store Restraint. More...

Inherits IMP.restrainer._restraint.Restraint.

Public Member Functions

def add_to_representation
 Place restraint into IMP Model. More...
 
def get_all_restraints_by_name
 Assuming there are many restraint objects with the same name. More...
 
def get_all_rigid_bodies
 Get all rigid bodies. More...
 
def get_restraint_by_name
 Assuming there is just one restraint object with the same name. More...
 
def get_rigid_body_by_id
 Get rigid body by particle id. More...
 
def show_all_restraints
 Show restraint name, initial weight, and score for the current state of the model.
 

Detailed Description

Note
This class is only available in Python.

Definition at line 31 of file restrainer/__init__.py.

Member Function Documentation

def IMP.restrainer.Restraint.add_to_representation (   self,
  repr 
)

Definition at line 33 of file restrainer/__init__.py.

def IMP.restrainer.Restraint.get_all_restraints_by_name (   self,
  name 
)
Parameters
[in]nameThe name to search for

Definition at line 42 of file restrainer/__init__.py.

def IMP.restrainer.Restraint.get_all_rigid_bodies (   self)

Definition at line 54 of file restrainer/__init__.py.

def IMP.restrainer.Restraint.get_restraint_by_name (   self,
  name 
)

Definition at line 46 of file restrainer/__init__.py.

def IMP.restrainer.Restraint.get_rigid_body_by_id (   self,
  id 
)

Definition at line 50 of file restrainer/__init__.py.


The documentation for this class was generated from the following file: