r14936 - /1.3/generic_fns/structure/api_base.py -- October 26, 2011 - 16:57

Author: bugman
Date: Wed Oct 26 16:57:34 2011
New Revision: 14936

URL: http://svn.gna.org/viewcvs/relax?rev=14936&view=rev
Log:
Added the translate method to the structural API.


Modified:
    1.3/generic_fns/structure/api_base.py

Modified: 1.3/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/api_base.py?rev=14936&r1=14935&r2=14936&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Wed Oct 26 16:57:34 2011
@@ -505,6 +505,19 @@
             target.append(file_root(file) + '_mol' + repr(mol_num))
 
 
+    def translate(self, T=None, model=None):
+        """Method stub for displacing the structural information by the 
given translation vector.
+
+        @keyword T:         The translation vector.
+        @type T:            numpy 3D, rank-1 array
+        @keyword model:     The model to rotate.  If None, all models will 
be rotated.
+        @type model:        int
+        """
+
+        # Raise the error.
+        raise RelaxImplementError
+
+
     def to_xml(self, doc, element):
         """Prototype method for converting the structural object to an XML 
representation.