IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP.EMageFit.buildxlinks.Xlink Class Reference

Class defining a cross-link. More...

Detailed Description

Class defining a cross-link.

Note
This class is only available in Python.

Definition at line 21 of file buildxlinks.py.

Public Member Functions

def __init__
 Initialize the class. More...
 
def get_name
 Generate a unique name for the restraint. More...
 
def swap
 swaps the order of the residues in the restraint More...
 

Constructor & Destructor Documentation

def IMP.EMageFit.buildxlinks.Xlink.__init__ (   self,
  id1,
  chain1,
  residue1,
  id2,
  chain2,
  residue2,
  distance 
)

Initialize the class.

Parameters
[in]id1Id of the first component of the cross-link
[in]chain1Chain of the first component
[in]residue1Residue cross-linked in the first component
[in]id2Id of the second component of the cross-link
[in]chain2chain1 Chain of the second component
[in]residue2Residue cross-linked in the second component
[in]distanceMaximum distance

Definition at line 30 of file buildxlinks.py.

Member Function Documentation

def IMP.EMageFit.buildxlinks.Xlink.get_name (   self)

Generate a unique name for the restraint.

Note
: The name cannot start with a number, upsets sqlite

Definition at line 82 of file buildxlinks.py.

def IMP.EMageFit.buildxlinks.Xlink.swap (   self)

swaps the order of the residues in the restraint

Definition at line 65 of file buildxlinks.py.


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