Source code for sas.models.SubComponent

#!/usr/bin/env python
""" Provide base functionality for all model components
    @author: Mathieu Doucet / UTK
    @contact: mathieu.doucet@nist.gov
"""

# info
__author__ = "Mathieu Doucet /  UTK"
__id__ = "$Id: BaseComponent.py,v 1.2 2007/03/14 21:04:40 doucet Exp $"
   
# imports   
from sas.models.BaseComponent import BaseComponent

[docs]class SubComponent(BaseComponent): """ Basic model component for Subtraction Provides basic arithmetics """ def __init__(self, base=None, other=None): """ @param base: component to subtract from @param other: component to subtract """ BaseComponent.__init__(self) # Component to subtract from self.operateOn = base # Component to subtract self.other = other # name self.name = 'SubComponent'
[docs] 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 """ return self.operateOn.run(x) - self.other.run(x)
[docs] 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 """ return self.operateOn.runXY(x) - self.other.runXY(x)
[docs] 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 """ return BaseComponent.setParamWithToken(self, name, value, 'sub', self.other)
[docs] def getParam(self, name): """ Set the value of a model parameter @param name: name of the parameter @return: value of the parameter """ return BaseComponent.getParamWithToken(self, name, 'sub', self.other)
[docs] def getParamList(self): """ Return a list of all available parameters for the model """ return BaseComponent.getParamListWithToken(self, 'sub', self.other) # End of file