r16498 - /branches/uf_redesign/specific_fns/api_objects.py -- May 29, 2012 - 10:24

Author: bugman
Date: Tue May 29 10:24:36 2012
New Revision: 16498

URL: http://svn.gna.org/viewcvs/relax?rev=16498&view=rev
Log:
All the get_*() methods of the specific API parameter list objects now call 
self.check_param().

This new check_param() method raises a RelaxError if the parameter is unknown.


Modified:
    branches/uf_redesign/specific_fns/api_objects.py

Modified: branches/uf_redesign/specific_fns/api_objects.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/specific_fns/api_objects.py?rev=16498&r1=16497&r2=16498&view=diff
==============================================================================
--- branches/uf_redesign/specific_fns/api_objects.py (original)
+++ branches/uf_redesign/specific_fns/api_objects.py Tue May 29 10:24:36 2012
@@ -108,6 +108,19 @@
             self._grace_string[name] = name
 
 
+    def check_param(self, name):
+        """Check if the parameter exists.
+
+        @param name:        The name of the parameter to search for.
+        @type name:         str
+        @raises RelaxError: If the parameter does not exist.
+        """
+
+        # Check.
+        if name not in self._names:
+            raise RelaxError("The parameter '%s' does not exist." % name)
+
+
     def contains(self, name):
         """Determine if the given name is within the parameter list.
 
@@ -134,9 +147,8 @@
         @rtype:         float
         """
 
-        # Check.
-        if name not in self._names:
-            return 1.0
+        # Parameter check.
+        self.check_param(name)
 
         # No factor.
         if self._conv_factor[name] == None:
@@ -159,9 +171,8 @@
         @rtype:         None or str
         """
 
-        # Check.
-        if name not in self._names:
-            return None
+        # Parameter check.
+        self.check_param(name)
 
         # Return the default value.
         return self._defaults[name]
@@ -176,9 +187,8 @@
         @rtype:         None or str
         """
 
-        # Check.
-        if name not in self._names:
-            return None
+        # Parameter check.
+        self.check_param(name)
 
         # Return the description.
         return self._desc[name]
@@ -193,9 +203,8 @@
         @rtype:         bool
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Return the type.
         return self._err[name]
@@ -210,9 +219,8 @@
         @rtype:         str
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Return the value.
         return self._grace_string[name]
@@ -227,9 +235,8 @@
         @rtype:         str
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Return the type.
         return self._param_set[name]
@@ -244,9 +251,8 @@
         @rtype:         bool
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Return the type.
         return self._sim[name]
@@ -261,9 +267,8 @@
         @rtype:         Python type object
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Return the Python type.
         return self._py_types[name]
@@ -278,9 +283,8 @@
         @rtype:         str
         """
 
-        # Check.
-        if name not in self._names:
-            raise RelaxError("The parameter '%s' does not exist." % name)
+        # Parameter check.
+        self.check_param(name)
 
         # Function.
         if isinstance(self._conv_factor[name], FunctionType) or 
isinstance(self._conv_factor[name], MethodType):