r5339 - /1.3/generic_fns/structure/api_base.py -- April 07, 2008 - 11:00

Author: bugman
Date: Mon Apr  7 11:00:45 2008
New Revision: 5339

URL: http://svn.gna.org/viewcvs/relax?rev=5339&view=rev
Log:
Added the terminate prototype method stub to the structral data 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=5339&r1=5338&r2=5339&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Mon Apr  7 11:00:45 2008
@@ -102,6 +102,19 @@
         raise RelaxImplementError
 
 
+    def terminate(self, atom_id_ext='', res_num=None):
+        """Prototype method stub for terminating the structural chain.
+
+        @param atom_id_ext:     The atom identifier extension.
+        @type atom_id_ext:      str
+        @param res_num:         The residue number.
+        @type res_num:          int
+        """
+
+        # Raise the error.
+        raise RelaxImplementError
+
+
     def xh_vector(self, spin, structure=None, unit=True):
         """Prototype method for calculating/extracting the XH vector from 
the loaded structure.