r16464 - /branches/uf_redesign/specific_fns/api_base.py -- May 25, 2012 - 18:52

Author: bugman
Date: Fri May 25 18:52:37 2012
New Revision: 16464

URL: http://svn.gna.org/viewcvs/relax?rev=16464&view=rev
Log:
The specific analysis API base return_data_desc() now has a basic 
implementation.

This will search through the global and then spin parameters objects, 
returning what ever is found.


Modified:
    branches/uf_redesign/specific_fns/api_base.py

Modified: branches/uf_redesign/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/specific_fns/api_base.py?rev=16464&r1=16463&r2=16464&view=diff
==============================================================================
--- branches/uf_redesign/specific_fns/api_base.py (original)
+++ branches/uf_redesign/specific_fns/api_base.py Fri May 25 18:52:37 2012
@@ -195,6 +195,7 @@
         """Return the default parameter values.
 
         This basic method will first search for a global parameter and, if 
not found, then a spin parameter.
+
 
         @param param:   The specific analysis parameter.
         @type param:    str
@@ -548,14 +549,24 @@
     def return_data_desc(self, name):
         """Return a description of the parameter.
 
+        This basic method will first search for a global parameter and, if 
not found, then a spin parameter.
+
+
         @param name:    The name or description of the parameter.
         @type name:     str
         @return:        The object description, or None.
         @rtype:         str or None
         """
 
-        # Not implemented.
-        raise RelaxImplementError('return_data_desc')
+        # The global parameter.
+        desc = self.GLOBAL_PARAMS.get_desc(name)
+
+        # A spin parameter.
+        if desc == None:
+            desc = self.SPIN_PARAMS.get_desc(name)
+
+        # Return the description.
+        return desc
 
 
     # Empty documentation string.