r8742 - /1.3/generic_fns/structure/api_base.py -- February 05, 2009 - 14:42

Author: bugman
Date: Thu Feb  5 14:42:51 2009
New Revision: 8742

URL: http://svn.gna.org/viewcvs/relax?rev=8742&view=rev
Log:
Modified the base API bond_vectors() method.


Modified:
    1.3/generic_fns/structure/api_base.py

Modified: 1.3/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/api_base.py?rev=8742&r1=8741&r2=8742&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Thu Feb  5 14:42:51 2009
@@ -149,18 +149,25 @@
         raise RelaxImplementError
 
 
-    def bond_vectors(self, atom_id=None, attached_atom=None, model_num=None, 
return_name=False, return_warnings=False):
+    def bond_vectors(self, attached_atom=None, model_num=None, 
mol_name=None, res_num=None, res_name=None, spin_num=None, spin_name=None, 
return_name=False, return_warnings=False):
         """Prototype method stub for finding the bond vectors between 
'attached_atom' and 'atom_id'.
 
-        @keyword atom_id:           The molecule, residue, and atom 
identifier string.  This must
-                                    correspond to a single atom in the 
system.
-        @type atom_id:              str
         @keyword attached_atom:     The name of the bonded atom.
         @type attached_atom:        str
         @keyword model_num:         The model of which to return the vectors 
from.  If not supplied
                                     and multiple models exist, then vectors 
from all models will be
                                     returned.
         @type model_num:            None or int
+        @keyword mol_name:          The name of the molecule that 
attached_atom belongs to.
+        @type mol_name:             str
+        @keyword res_num:           The number of the residue that 
attached_atom belongs to.
+        @type res_num:              str
+        @keyword res_name:          The name of the residue that 
attached_atom belongs to.
+        @type res_name:             str
+        @keyword spin_num:          The number of the spin that 
attached_atom is attached to.
+        @type spin_num:             str
+        @keyword spin_name:         The name of the spin that attached_atom 
is attached to.
+        @type spin_name:            str
         @keyword return_name:       A flag which if True will cause the name 
of the attached atom to
                                     be returned together with the bond 
vectors.
         @type return_name:          bool