r7424 - /1.3/generic_fns/structure/api_base.py -- September 27, 2008 - 20:09

Author: bugman
Date: Sat Sep 27 20:09:41 2008
New Revision: 7424

URL: http://svn.gna.org/viewcvs/relax?rev=7424&view=rev
Log:
Added the add_struct() stub method to the structural API base class.


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=7424&r1=7423&r2=7424&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Sat Sep 27 20:09:41 2008
@@ -59,6 +59,28 @@
         self.file = []
         self.path = []
         self.structural_data = []
+
+
+    def add_struct(self, name=None, model=None, file=None, path=None, 
str=None, struct_index=None):
+        """Prototype method stub for adding the given structure to the store.
+
+        @keyword name:          The structural identifier.
+        @type name:             str
+        @keyword model:         The structural model.
+        @type model:            int or None
+        @keyword file:          The name of the file containing the 
structure.
+        @type file:             str
+        @keyword path:          The optional path where the file is located.
+        @type path:             str
+        @keyword str:           The object containing the structural data.
+        @type str:              Structure_container instance
+        @keyword struct_index:  The index of the structural container, used 
for replacing the
+                                structure.
+        @type struct_index:     int or None.
+        """
+
+        # Raise the error.
+        raise RelaxImplementError
 
 
     def atom_add(self, pdb_record=None, atom_num=None, atom_name=None, 
res_name=None, chain_id=None, res_num=None, pos=[None, None, None], 
segment_id=None, element=None, struct_index=None):