r5338 - /1.3/generic_fns/structure/api_base.py -- April 07, 2008 - 10:58

Author: bugman
Date: Mon Apr  7 10:58:25 2008
New Revision: 5338

URL: http://svn.gna.org/viewcvs/relax?rev=5338&view=rev
Log:
Added the atom_connect 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=5338&r1=5337&r2=5338&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Mon Apr  7 10:58:25 2008
@@ -67,6 +67,22 @@
         raise RelaxImplementError
 
 
+    def atom_connect(self, atom_id=None, bonded_id=None):
+        """Prototype method stub for connecting two atoms within the data 
structure object.
+
+        This method will connect the atoms corresponding to atom_id and 
bonded_id.
+
+
+        @param atom_id:     The atom identifier.
+        @type atom_id:      str
+        @param bonded_id:   The second atom identifier.
+        @type bonded_id:    str
+        """
+
+        # Raise the error.
+        raise RelaxImplementError
+
+
     def load_structures(self, file_path, model, verbosity=False):
         """Prototype method for loading structures from a file.