r15588 - /1.3/multi/__init__.py -- March 21, 2012 - 11:08

Author: bugman
Date: Wed Mar 21 11:08:07 2012
New Revision: 15588

URL: http://svn.gna.org/viewcvs/relax?rev=15588&view=rev
Log:
Created the stub functions data_fetch() and data_upload() for the 
multi-processor API.

For details, see the message at 
https://mail.gna.org/public/relax-devel/2012-03/msg00011.html
(Message-id: 
<CAED9pY9Hb=0iywMNVBGjS=YcZgNFe+5X-nKhubKhWAWiN4Psgg@xxxxxxxxxxxxxx>).


Modified:
    1.3/multi/__init__.py

Modified: 1.3/multi/__init__.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/multi/__init__.py?rev=15588&r1=15587&r2=15588&view=diff
==============================================================================
--- 1.3/multi/__init__.py (original)
+++ 1.3/multi/__init__.py Wed Mar 21 11:08:07 2012
@@ -197,6 +197,40 @@
     return object
 
 
+def data_fetch(name=None):
+    """API function for obtaining data from the Processor instance's data 
store.
+
+    This is for fetching data from the data store of the Processor instance. 
 
+
+
+    @keyword name:  The name of the data structure to fetch.
+    @type name:     str
+    @return:        The value of the associated data structure.
+    @rtype:         anything
+    """
+
+    # Load the Processor_box.
+    processor_box = Processor_box()
+
+
+def data_upload(name=None, value=None, rank=None):
+    """API function for sending data to be stored on the Processor of the 
given rank.
+
+    This can be used for transferring data from Processor instance i to the 
data store of Processor instance j.
+
+
+    @keyword name:  The name of the data structure to store.
+    @type name:     str
+    @keyword value: The data structure.
+    @type value:    anything
+    @keyword rank:  An optional argument to send data only to the Processor 
of the given rank.  If None, then the data will be sent to all Processor 
instances.
+    @type rank:     None or int
+    """
+
+    # Load the Processor_box.
+    processor_box = Processor_box()
+
+
 
 class Application_callback(object):
     """Call backs provided to the host application by the multi processor 
framework.