Changeset 79ac6f8 in sasview for sansmodels/src/sans/models/AddComponent.py

Timestamp:

Jun 4, 2010 5:04:49 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

5062bbf

Parents:

7116b6e0

Message:

working on documentation

File:

• sansmodels/src/sans/models/AddComponent.py (modified) (6 diffs)

sansmodels/src/sans/models/AddComponent.py

@@ -1 +1 @@
 #!/usr/bin/env python
-""" Provide base functionality for all model components
-    @author: Mathieu Doucet / UTK
-    @contact: mathieu.doucet@nist.gov
+
+""" 
+Provide base functionality for all model components
+
+:author: Mathieu Doucet / UTK
+
+:contact: mathieu.doucet@nist.gov
+
 """
 
@@ -13 +18 @@
 
 class AddComponent(BaseComponent):
-    """ Basic model component for Addition
-        Provides basic arithmetics
+    """ 
+    Basic model component for Addition
+    Provides basic arithmetics
     """
 
     def __init__(self, base=None, other=None):
         """
-            @param base: component to add to 
-            @param other: component to add
+        :param base: component to add to 
+        :param other: component to add
+        
         """
         BaseComponent.__init__(self)
@@ -32 +39 @@
     def run(self, x=0):
         """
-            Evaluate each part of the component and sum the results
-            @param x: input parameter
-            @return: value of the model at x
+        Evaluate each part of the component and sum the results
+        
+        :param x: input parameter
+        
+        :return: value of the model at x
+        
         """
         return self.operateOn.run(x) + self.other.run(x)
@@ -40 +50 @@
     def runXY(self, x=0):
         """
-            Evaluate each part of the component and sum the results
-            @param x: input parameter
-            @return: value of the model at x
+        Evaluate each part of the component and sum the results
+        
+        :param x: input parameter
+        
+        :return: value of the model at x
+        
         """
         return self.operateOn.runXY(x) + self.other.runXY(x)
@@ -48 +61 @@
     def setParam(self, name, value):
         """ 
-            Set the value of a model parameter
-            @param name: name of parameter to set
-            @param value: value to give the paramter
+        Set the value of a model parameter
+        
+        :param name: name of parameter to set
+        :param value: value to give the paramter
+        
         """
         return BaseComponent.setParamWithToken(self, name, 
@@ -57 +72 @@
     def getParam(self, name):
         """ 
-            Set the value of a model parameter
-            @param name: name of the parameter
-            @return: value of the parameter
+        Set the value of a model parameter
+        
+        :param name: name of the parameter
+        
+        :return: value of the parameter
+        
         """
         return BaseComponent.getParamWithToken(self, name, 'add', self.other)
     
     def getParamList(self):
-        """ Return a list of all available parameters for the model 
+        """ 
+        Return a list of all available parameters for the model 
         """
         return BaseComponent.getParamListWithToken(self, 'add', self.other)