r15188 - /branches/spec_api/specific_fns/api_objects.py -- January 19, 2012 - 11:20

Author: bugman
Date: Thu Jan 19 11:20:08 2012
New Revision: 15188

URL: http://svn.gna.org/viewcvs/relax?rev=15188&view=rev
Log:
Added the ability to store and return conversion factors in the Param_list 
specific API object.

This includes accepting functions so that factors requiring user loaded data 
can be supported.


Modified:
    branches/spec_api/specific_fns/api_objects.py

Modified: branches/spec_api/specific_fns/api_objects.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/spec_api/specific_fns/api_objects.py?rev=15188&r1=15187&r2=15188&view=diff
==============================================================================
--- branches/spec_api/specific_fns/api_objects.py (original)
+++ branches/spec_api/specific_fns/api_objects.py Thu Jan 19 11:20:08 2012
@@ -42,7 +42,7 @@
         self._grace_string = {}
 
 
-    def add(self, name, string=None, default=None, units=None, desc=None, 
grace_string=None):
+    def add(self, name, string=None, default=None, units=None, desc=None, 
conv_factor=None, grace_string=None):
         """Add a parameter to the list.
 
         @param name:            The name of the parameter.  This will be 
used as the variable name.
@@ -55,6 +55,8 @@
         @type units:            None or str
         @keyword desc:          The text description of the parameter.
         @type desc:             None or str
+        @keyword conv_factor:   The factor of conversion between different 
parameter units.
+        @type conv_factor:      None, float or func
         @keyword grace_string:  The string used for the axes in Grace plots 
of the data.
         @type grace_string:     None or str
         """
@@ -64,6 +66,7 @@
         self._defaults[name] = default
         self._units[name] = units
         self._desc[name] = desc
+        self._conv_factor[name] = conv_factor
 
         # The parameter string.
         if string:
@@ -93,6 +96,31 @@
 
         # No match.
         return False
+
+
+    def get_conv_factor(self, name):
+        """Return the conversion factor.
+
+        @param name:    The name of the parameter.
+        @type name:     str
+        @return:        The conversion factor.
+        @rtype:         None or float
+        """
+
+        # Check.
+        if name not in self._names:
+            return None
+
+        # No factor.
+        if self._conv_factor[name] == None:
+            return None
+
+        # Function.
+        if isinstance(self._conv_factor[name], func):
+            return func()
+
+        # Value.
+        return self._conv_factor[name]
 
 
     def get_desc(self, name):