IMP logo

IMP::restrainer::Restraint Class Reference


Detailed Description

Store Restraint.

Public Member Functions

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

Member Function Documentation

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

Place restraint into IMP Model.

def IMP::restrainer::Restraint::get_all_restraints_by_name (   self,
  name 
)

Assuming there are many restraint objects with the same name.

Parameters:
[in] name The name to search for

def IMP::restrainer::Restraint::get_all_rigid_bodies (   self  ) 

Get all rigid bodies.

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

Assuming there is just one restraint object with the same name.

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

Get rigid body by particle id.


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

Generated on Mon Mar 8 23:09:02 2010 for IMP by doxygen 1.5.8