r13855 - in /1.3: generic_fns/relax_data.py prompt/relax_data.py -- July 25, 2011 - 13:45

Author: bugman
Date: Mon Jul 25 13:45:04 2011
New Revision: 13855

URL: http://svn.gna.org/viewcvs/relax?rev=13855&view=rev
Log:
Added the argument 'bc' to the relax_data.write() user function front end.

This currently doesn't do anything.


Modified:
    1.3/generic_fns/relax_data.py
    1.3/prompt/relax_data.py

Modified: 1.3/generic_fns/relax_data.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/relax_data.py?rev=13855&r1=13854&r2=13855&view=diff
==============================================================================
--- 1.3/generic_fns/relax_data.py (original)
+++ 1.3/generic_fns/relax_data.py Mon Jul 25 13:45:04 2011
@@ -921,7 +921,7 @@
     cdp.exp_info.temp_control_setup(ri_id, method)
 
 
-def write(ri_id=None, file=None, dir=None, force=False):
+def write(ri_id=None, file=None, dir=None, bc=False, force=False):
     """Write relaxation data to a file.
 
     @keyword ri_id: The relaxation data ID string.
@@ -930,6 +930,8 @@
     @type file:     str
     @keyword dir:   The directory to write to.
     @type dir:      str or None
+    @keyword bc:    A flag which if True will cause the back-calculated 
relaxation data to be written.
+    @type bc:       bool
     @keyword force: A flag which if True will cause any pre-existing file to 
be overwritten.
     @type force:    bool
     """

Modified: 1.3/prompt/relax_data.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/relax_data.py?rev=13855&r1=13854&r2=13855&view=diff
==============================================================================
--- 1.3/prompt/relax_data.py (original)
+++ 1.3/prompt/relax_data.py Mon Jul 25 13:45:04 2011
@@ -420,7 +420,7 @@
         relax_data.temp_control(ri_id=ri_id, method=method)
 
 
-    def write(self, ri_id=None, file=None, dir=None, force=False):
+    def write(self, ri_id=None, file=None, dir=None, bc=False, force=False):
         """Write relaxation data to a file.
 
         Keyword Arguments
@@ -431,6 +431,9 @@
         file:  The name of the file.
 
         dir:  The directory name.
+
+        bc:  A flag which if True will cause the back-calculated relaxation 
data to be written to
+        file rather than the actual data.
 
         force:  A flag which if True will cause the file to be overwritten.
 
@@ -448,6 +451,7 @@
             text = text + "ri_id=" + repr(ri_id)
             text = text + ", file=" + repr(file)
             text = text + ", dir=" + repr(dir)
+            text = text + ", bc=" + repr(bc)
             text = text + ", force=" + repr(force) + ")"
             print(text)
 
@@ -455,7 +459,8 @@
         arg_check.is_str(ri_id, 'relaxation label')
         arg_check.is_str(file, 'file name')
         arg_check.is_str(dir, 'directory name', can_be_none=True)
+        arg_check.is_bool(bc, 'back-calculated data flag')
         arg_check.is_bool(force, 'force flag')
 
         # Execute the functional code.
-        relax_data.write(ri_id=ri_id, file=file, dir=dir, force=force)
+        relax_data.write(ri_id=ri_id, file=file, dir=dir, bc=bc, force=force)