r13904 - /1.3/specific_fns/api_base.py -- July 26, 2011 - 21:40

Author: bugman
Date: Tue Jul 26 21:40:15 2011
New Revision: 13904

URL: http://svn.gna.org/viewcvs/relax?rev=13904&view=rev
Log:
Added the data_type() method to the specific functions API.

This will be used to determine the type that a given parameter from 
data_names() should be.


Modified:
    1.3/specific_fns/api_base.py

Modified: 1.3/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=13904&r1=13903&r2=13904&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Tue Jul 26 21:40:15 2011
@@ -143,6 +143,19 @@
         @type sim_names:        bool
         @return:                The list of object names.
         @rtype:                 list of str
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
+
+
+    def data_type(self, param=None):
+        """Return the type of data, as a string, that the parameter should 
be.
+
+        @keyword param:     The parameter name.
+        @type param:        list of str
+        @return:            The type of the parameter, as a string.  I.e. 
'int', 'float', 'str', 'bool', 'list of str', 'dict of bool', etc.
+        @rtype:             str
         """
 
         # Not implemented.