r5630 - in /1.3/generic_fns/structure: api_base.py geometric.py internal_pdb.py scientific.py -- April 13, 2008 - 18:58

Author: bugman
Date: Sun Apr 13 18:58:44 2008
New Revision: 5630

URL: http://svn.gna.org/viewcvs/relax?rev=5630&view=rev
Log:
Renamed the class 'Str_object' to 'Base_struct_API'.


Modified:
    1.3/generic_fns/structure/api_base.py
    1.3/generic_fns/structure/geometric.py
    1.3/generic_fns/structure/internal_pdb.py
    1.3/generic_fns/structure/scientific.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=5630&r1=5629&r2=5630&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Sun Apr 13 18:58:44 2008
@@ -31,8 +31,11 @@
 from relax_errors import RelaxImplementError
 
 
-class Str_object:
-    """The structural object base class."""
+class Base_struct_API:
+    """The structural object base class.
+
+    All API methods are prototyped here as stub methods.
+    """
 
 
     def __init__(self):

Modified: 1.3/generic_fns/structure/geometric.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/geometric.py?rev=5630&r1=5629&r2=5630&view=diff
==============================================================================
--- 1.3/generic_fns/structure/geometric.py (original)
+++ 1.3/generic_fns/structure/geometric.py Sun Apr 13 18:58:44 2008
@@ -66,7 +66,7 @@
 
 
     @param structure:       The structural data object.
-    @type structure:        instance of class derived from Str_object
+    @type structure:        instance of class derived from Base_struct_API
     @param res_name:        The residue name.
     @type res_name:         str
     @param res_num:         The residue number.
@@ -476,7 +476,7 @@
 
 
     @param structure:       The structural data object.
-    @type structure:        instance of class derived from Str_object
+    @type structure:        instance of class derived from Base_struct_API
     @param atom_id_ext:     The atom identifier extension.
     @type atom_id_ext:      str
     @param res_name:        The residue name.
@@ -577,7 +577,7 @@
     simulations.
 
     @param structure:       The structural data object.
-    @type structure:        instance of class derived from Str_object
+    @type structure:        instance of class derived from Base_struct_API
     @param vector:          The vector to be represented in the PDB.
     @type vector:           numpy array, len 3
     @param atom_name:       The atom name used to label the atom 
representing the head of the
@@ -658,7 +658,7 @@
     """Function for stitching the cap of a cone to the cone edge, in the PDB 
representations.
 
     @param structure:       The structural data object.
-    @type structure:        instance of class derived from Str_object
+    @type structure:        instance of class derived from Base_struct_API
     @param atom_id_ext:     The atom identifier extension.
     @type atom_id_ext:      str
     @param max_angle:       The maximal polar angle, in rad, after which all 
vectors are skipped.

Modified: 1.3/generic_fns/structure/internal_pdb.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/internal_pdb.py?rev=5630&r1=5629&r2=5630&view=diff
==============================================================================
--- 1.3/generic_fns/structure/internal_pdb.py (original)
+++ 1.3/generic_fns/structure/internal_pdb.py Sun Apr 13 18:58:44 2008
@@ -25,12 +25,12 @@
 
 
 # relax module imports.
-from api_base import Str_object
+from api_base import Base_struct_API
 from relax_errors import RelaxError
 
 
 
-class Internal_PDB(Str_object):
+class Internal_PDB(Base_struct_API):
     """The internal relax PDB data object.
 
     The structural data object for this class is a dictionary of arrays.  
The keys correspond to the

Modified: 1.3/generic_fns/structure/scientific.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/scientific.py?rev=5630&r1=5629&r2=5630&view=diff
==============================================================================
--- 1.3/generic_fns/structure/scientific.py (original)
+++ 1.3/generic_fns/structure/scientific.py Sun Apr 13 18:58:44 2008
@@ -37,14 +37,14 @@
     module_avail = False
 
 # relax module imports.
-from api_base import Str_object
+from api_base import Base_struct_API
 from data import Data as relax_data_store
 from generic_fns.selection import parse_token, tokenise
 from relax_errors import RelaxNoPdbChainError, RelaxNoResError, 
RelaxPdbLoadError
 from relax_warnings import RelaxNoAtomWarning, RelaxZeroVectorWarning
 
 
-class Scientific_data(Str_object):
+class Scientific_data(Base_struct_API):
     """The Scientific Python specific data object."""
 
     # Identification string.