r16927 - /branches/interatomic/generic_fns/structure/api_base.py -- June 18, 2012 - 09:50

Author: bugman
Date: Mon Jun 18 09:50:31 2012
New Revision: 16927

URL: http://svn.gna.org/viewcvs/relax?rev=16927&view=rev
Log:
Created the structural API base are_bonded() method - this is for determining 
if 2 atoms are bonded.

This is a method stub which raises a RelaxImplementError.


Modified:
    branches/interatomic/generic_fns/structure/api_base.py

Modified: branches/interatomic/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/interatomic/generic_fns/structure/api_base.py?rev=16927&r1=16926&r2=16927&view=diff
==============================================================================
--- branches/interatomic/generic_fns/structure/api_base.py (original)
+++ branches/interatomic/generic_fns/structure/api_base.py Mon Jun 18 
09:50:31 2012
@@ -116,6 +116,21 @@
 
         # Raise the error.
         raise RelaxImplementError
+
+
+    def are_bonded(self, atom_id1=None, atom_id2=None):
+        """Prototype method stub for determining if two atoms are directly 
bonded to each other.
+
+        @keyword atom_id1:  The molecule, residue, and atom identifier 
string of the first atom.
+        @type atom_id1:     str
+        @keyword atom_id1:  The molecule, residue, and atom identifier 
string of the second atom.
+        @type atom_id1:     str
+        @return:            True if the atoms are directly bonded.
+        @rtype:             bool
+        """
+
+        # Raise the error.
+        raise RelaxImplementError('are_bonded')
 
 
     def atom_loop(self, atom_id=None, str_id=None, model_num=None, 
model_num_flag=False, mol_name_flag=False, res_num_flag=False, 
res_name_flag=False, atom_num_flag=False, atom_name_flag=False, 
element_flag=False, pos_flag=False, ave=False):