r5315 - /1.3/generic_fns/structure/api_base.py -- April 04, 2008 - 17:04

Author: bugman
Date: Fri Apr  4 17:04:18 2008
New Revision: 5315

URL: http://svn.gna.org/viewcvs/relax?rev=5315&view=rev
Log:
Added the load_structures() prototype method stub.


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=5315&r1=5314&r2=5315&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Fri Apr  4 17:04:18 2008
@@ -26,9 +26,31 @@
 The API is set up as a series of methods attached to the structural object 
defined in this module.
 """
 
+# relax module import.
+from relax_errors import RelaxImplementError
+
 
 class Str_object:
     """The structural object base class."""
 
     # The parser specific data object.
     structural_data = []
+
+
+    def load_structures(self, file_path, model, verbosity=False):
+        """Prototype method for loading structures from a file.
+
+        This inherited prototype method is a stub which, if the 
functionality is desired, should be
+        overwritten by the derived class.
+
+
+        @param file_path:   The full path of the file.
+        @type file_path:    str
+        @param model:       The structural model to use.
+        @type model:        int
+        @keyword verbosity: A flag which if True will cause messages to be 
printed.
+        @type verbosity:    bool
+        """
+
+        # Raise the error.
+        raise RelaxImplementError