r6667 - /branches/rdc_analysis/generic_fns/structure/api_base.py -- July 04, 2008 - 15:58

Author: bugman
Date: Fri Jul  4 15:58:28 2008
New Revision: 6667

URL: http://svn.gna.org/viewcvs/relax?rev=6667&view=rev
Log:
Added the str_id arg to the atom_loop() structural API method.


Modified:
    branches/rdc_analysis/generic_fns/structure/api_base.py

Modified: branches/rdc_analysis/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/rdc_analysis/generic_fns/structure/api_base.py?rev=6667&r1=6666&r2=6667&view=diff
==============================================================================
--- branches/rdc_analysis/generic_fns/structure/api_base.py (original)
+++ branches/rdc_analysis/generic_fns/structure/api_base.py Fri Jul  4 
15:58:28 2008
@@ -104,7 +104,7 @@
         raise RelaxImplementError
 
 
-    def atom_loop(self, atom_id=None, model_num_flag=False, 
mol_name_flag=False, res_num_flag=False, res_name_flag=False, 
atom_num_flag=False, atom_name_flag=False, element_flag=False, 
pos_flag=False):
+    def atom_loop(self, atom_id=None, str_id=None, model_num_flag=False, 
mol_name_flag=False, res_num_flag=False, res_name_flag=False, 
atom_num_flag=False, atom_name_flag=False, element_flag=False, 
pos_flag=False):
         """Prototype generator method stub for looping over all atoms in the 
structural data object.
 
         This method should be designed as a generator 
(http://www.python.org/dev/peps/pep-0255/).
@@ -125,6 +125,10 @@
         @keyword atom_id:           The molecule, residue, and atom 
identifier string.  Only atoms
                                     matching this selection will be yielded.
         @type atom_id:              str
+        @keyword str_id:            The structure identifier.  This can be 
the file name, model
+                                    number, or structure number.  If None, 
then all structures will
+                                    be looped over.
+        @type str_id:               str, int, or None
         @keyword model_num_flag:    A flag which if True will cause the 
model number to be yielded.
         @type model_num_flag:       bool
         @keyword mol_name_flag:     A flag which if True will cause the 
molecule name to be yielded.