r6823 - /1.3/generic_fns/structure/api_base.py -- July 08, 2008 - 02:09

Author: bugman
Date: Tue Jul  8 02:04:51 2008
New Revision: 6823

URL: http://svn.gna.org/viewcvs/relax?rev=6823&view=rev
Log:
Added the missing return_name and return_warnings args to the structural 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=6823&r1=6822&r2=6823&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Tue Jul  8 02:04:51 2008
@@ -184,20 +184,25 @@
         raise RelaxImplementError
 
 
-    def bond_vectors(self, atom_id=None, attached_atom=None, 
struct_index=None):
+    def bond_vectors(self, atom_id=None, attached_atom=None, 
struct_index=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 struct_index:  The index of the structure to return the 
vectors from.  If not
-                                supplied and multiple structures/models 
exist, then vectors from all
-                                structures will be returned.
-        @type struct_index:     None or int
-        @return:                The list of bond vectors for each model.
-        @rtype:                 list of numpy arrays
+        @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 struct_index:      The index of the structure to return the 
vectors from.  If not
+                                    supplied and multiple structures/models 
exist, then vectors from
+                                    all structures will be returned.
+        @type struct_index:         None or int
+        @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
+        @keyword return_warnings:   A flag which if True will cause warning 
messages to be returned.
+        @type return_warnings:      bool
+        @return:                    The list of bond vectors for each model.
+        @rtype:                     list of numpy arrays
         """
 
         # Raise the error.