r22739 - /trunk/specific_analyses/parameter_object.py -- April 14, 2014 - 17:07

Author: bugman
Date: Mon Apr 14 17:07:11 2014
New Revision: 22739

URL: http://svn.gna.org/viewcvs/relax?rev=22739&view=rev
Log:
Created the parameter list object base class _uf_doc_loop() method.

This will be used to loop over all or subsets of the user function 
documentation parameter tables.


Modified:
    trunk/specific_analyses/parameter_object.py

Modified: trunk/specific_analyses/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/parameter_object.py?rev=22739&r1=22738&r2=22739&view=diff
==============================================================================
--- trunk/specific_analyses/parameter_object.py (original)
+++ trunk/specific_analyses/parameter_object.py Mon Apr 14 17:07:11 2014
@@ -343,6 +343,24 @@
         return self._uf_docs[label]
 
 
+    def _uf_doc_loop(self, tables=None):
+        """Generator method for looping over and yielding the user function 
parameter documentation.
+
+        @keyword tables:    The list of tables to loop over.  If None, then 
all tables will be yielded.
+        @type tables:       list of str or None
+        @return:            The user function documentation for each table.
+        @rtype:             Desc_container instance
+        """
+
+        # No tables supplied.
+        if tables == None:
+            tables = self._uf_docs.keys()
+
+        # Loop over the tables, yielding the documentation objects.
+        for table in tables:
+            yield self._uf_docs[table]
+
+
     def base_loop(self, set=None, scope=None):
         """An iterator method for looping over all the base parameters.