r3512 - /1.3/generic_fns/selection.py -- November 11, 2007 - 22:43

Author: bugman
Date: Sun Nov 11 22:43:40 2007
New Revision: 3512

URL: http://svn.gna.org/viewcvs/relax?rev=3512&view=rev
Log:
Added the full_info flag to the generic_fns.selection.residue_loop() function.


Modified:
    1.3/generic_fns/selection.py

Modified: 1.3/generic_fns/selection.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/selection.py?rev=3512&r1=3511&r2=3512&view=diff
==============================================================================
--- 1.3/generic_fns/selection.py (original)
+++ 1.3/generic_fns/selection.py Sun Nov 11 22:43:40 2007
@@ -427,15 +427,21 @@
     return list
 
 
-def residue_loop(selection=None, pipe=None):
+def residue_loop(selection=None, pipe=None, full_info=False):
     """Generator function for looping over all the residues of the given 
selection.
 
     @param selection:   The residue selection identifier.
     @type selection:    str
     @param pipe:        The data pipe containing the residue.  Defaults to 
the current data pipe.
     @type pipe:         str
-    @return:            The residue specific data container.
-    @rtype:             instance of the ResidueContainer class.
+    @param full_info:   A flag specifying if the amount of information to be 
returned.  If false,
+                        only the data container is returned.  If true, the 
molecule name, residue
+                        number, and residue name is additionally returned.
+    @type full_info:    boolean
+    @return:            The residue specific data container and, if 
full_info=True, the molecule
+                        name.
+    @rtype:             instance of the ResidueContainer class.  If 
full_info=True, the type is the
+                        tuple (ResidueContainer, str).
     """
 
     # The data pipe.
@@ -458,7 +464,10 @@
                 continue
 
             # Yield the residue data container.
-            yield res
+            if full_info:
+                yield res, mol.name
+            else:
+                yield res
 
 
 def return_molecule(selection=None, pipe=None):
@@ -947,6 +956,7 @@
     @param full_info:   A flag specifying if the amount of information to be 
returned.  If false,
                         only the data container is returned.  If true, the 
molecule name, residue
                         number, and residue name is additionally returned.
+    @type full_info:    boolean
     @return:            The spin system specific data container and, if 
full_info=True, the molecule
                         name, residue number, and residue name.
     @rtype:             instance of the SpinContainer class.  If 
full_info=True, the type is the