r5524 - /1.3/generic_fns/structure/api_base.py -- April 10, 2008 - 11:28

Author: bugman
Date: Thu Apr 10 11:28:00 2008
New Revision: 5524

URL: http://svn.gna.org/viewcvs/relax?rev=5524&view=rev
Log:
Added the 'atom_id' arg to the structural API atom_loop() generator method 
stub.


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=5524&r1=5523&r2=5524&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Thu Apr 10 11:28:00 2008
@@ -88,7 +88,7 @@
         raise RelaxImplementError
 
 
-    def atom_loop(self, 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, 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/).
@@ -105,6 +105,9 @@
             7.  The position of the atom in Euclidean space.
 
 
+        @keyword atom_id:           The molecule, residue, and atom 
identifier string.  Only atoms
+                                    matching this selection will be yielded.
+        @type atom_id:              str
         @keyword mol_name_flag:     A flag which if True will cause the 
molecule name to be yielded.
         @type mol_name_flag:        bool
         @keyword res_num_flag:      A flag which if True will cause the 
residue number to be