r9990 - /branches/bmrb/specific_fns/api_base.py -- November 27, 2009 - 10:50

Author: bugman
Date: Fri Nov 27 10:50:50 2009
New Revision: 9990

URL: http://svn.gna.org/viewcvs/relax?rev=9990&view=rev
Log:
Added bmrb_read() and bmrb_write() to the analysis specific base API.


Modified:
    branches/bmrb/specific_fns/api_base.py

Modified: branches/bmrb/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/specific_fns/api_base.py?rev=9990&r1=9989&r2=9990&view=diff
==============================================================================
--- branches/bmrb/specific_fns/api_base.py (original)
+++ branches/bmrb/specific_fns/api_base.py Fri Nov 27 10:50:50 2009
@@ -54,6 +54,30 @@
 
             # Yield the spin id string.
             yield spin_id
+
+
+    def bmrb_read(self, file_path, version=None):
+        """Prototype method for reading the data from a BMRB NMR-STAR v3.1 
formatted file.
+
+        @param file_path:   The full file path.
+        @type file_path:    str
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
+
+
+    def bmrb_write(self, file_path, version=None):
+        """Prototype method for writing the data to a BMRB NMR-STAR 
formatted file.
+
+        @param file_path:   The full file path.
+        @type file_path:    str
+        @keyword version:   The BMRB NMR-STAR dictionary format to output to.
+        @type version:      str
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
 
 
     def calculate(self, spin_id=None, verbosity=1, sim_index=None):