r14348 - /1.3/specific_fns/api_base.py -- August 11, 2011 - 11:37

Author: bugman
Date: Thu Aug 11 11:37:27 2011
New Revision: 14348

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


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=14348&r1=14347&r2=14348&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Thu Aug 11 11:37:27 2011
@@ -413,7 +413,7 @@
     def molmol_macro(self, data_type, style=None, colour_start=None, 
colour_end=None, colour_list=None, spin_id=None):
         """Create and return an array of Molmol macros.
 
-        @param param:           The parameter name.
+        @param param:           The parameter name or data type.
         @type param:            str
         @keyword style:         The Molmol style.
         @type style:            None or str
@@ -449,6 +449,27 @@
         raise RelaxImplementError
 
 
+    def pymol_macro(self, data_type, style=None, colour_start=None, 
colour_end=None, colour_list=None, spin_id=None):
+        """Create and return an array of PyMOL macros.
+
+        @param param:           The parameter name or data type.
+        @type param:            str
+        @keyword style:         The PyMOL style.
+        @type style:            None or str
+        @keyword colour_start:  The starting colour (must be a MOLMOL or X11 
name).
+        @type colour_start:     str
+        @keyword colour_end:    The ending colour (must be a MOLMOL or X11 
name).
+        @type colour_end:       str
+        @keyword colour_list:   The colour list used, either 'molmol' or 
'x11'.
+        @type colour_list:      str
+        @keyword spin_id:       The spin identification string.
+        @type spin_id:          str
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
+
+
     def read_columnar_results(self, file_data, verbosity=1):
         """Read the columnar formatted results file.