mailr10005 - /1.3/specific_fns/api_base.py


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by edward on November 27, 2009 - 18:31:
Author: bugman
Date: Fri Nov 27 18:31:04 2009
New Revision: 10005

URL: http://svn.gna.org/viewcvs/relax?rev=10005&view=rev
Log:
Added the set_param_values() method to the base API (matching the changes of 
r9986).


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=10005&r1=10004&r2=10005&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Fri Nov 27 18:31:04 2009
@@ -672,18 +672,21 @@
             inc = inc + 1
 
 
-    def set_non_spin_params(self, value=None, param=None):
-        """Base class method which complains loudly if anything is supplied 
to it.
-
-        @param value:   The parameter values.
-        @type value:    None, number, or list of numbers
-        @param param:   The parameter names.
-        @type param:    None, str, or list of str
-        """
-
-        # Throw a RelaxError.
-        if value or param:
-            raise RelaxError("Do not know how to handle the non-spin 
specific parameters " + repr(param) + " with the values " + repr(value))
+    def set_param_values(self, param=None, value=None, spin_id=None, 
force=True):
+        """Prototype method for setting model parameter values.
+
+        @keyword param:     The parameter name.
+        @type param:        str
+        @keyword value:     The parameter value.
+        @type value:        number
+        @keyword spin_id:   The spin identification string, only used for 
spin specific parameters.
+        @type spin_id:      None or str
+        @keyword force:     A flag which if True will cause current values 
to be overwritten.  If False, a RelaxError will raised if the parameter value 
is already set.
+        @type force:        bool
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
 
 
     def set_selected_sim(self, model_info, select_sim):




Related Messages


Powered by MHonArc, Updated Fri Nov 27 18:40:02 2009