GainFunction Class Reference

GainFunction. More...

Inheritance diagram for GainFunction:

List of all members.

Public Member Functions

 GainFunction (double gain=1.0)
 Construct.
virtual ~GainFunction ()
 Destructor.
virtual void apply (DoubleVector &inputs, DoubleVector &outputs)
 Implement the Gain function.
virtual void configure (ConfigurationParameters &params, QString prefix)
 Configures the object using a ConfigurationParameters object.
virtual bool derivate (const DoubleVector &x, const DoubleVector &y, DoubleVector &d) const
 return always 1 (an explain of why will be coming soon)
virtual void save (ConfigurationParameters &params, QString prefix)
 Save the actual status of parameters into the ConfigurationParameters object passed.

Public Attributes

double gainv

Detailed Description

GainFunction.

GainFunction add a constan value to inputs

Definition at line 111 of file liboutputfunctions.h.


Constructor & Destructor Documentation

GainFunction ( double  gain = 1.0)

Construct.

Definition at line 87 of file liboutputfunctions.cpp.

virtual ~GainFunction ( ) [inline, virtual]

Destructor.

Definition at line 116 of file liboutputfunctions.h.


Member Function Documentation

void apply ( DoubleVector inputs,
DoubleVector outputs 
) [virtual]

Implement the Gain function.

Implements OutputFunction.

Definition at line 92 of file liboutputfunctions.cpp.

References DoubleVector::copyValues().

void configure ( ConfigurationParameters params,
QString  prefix 
) [virtual]

Configures the object using a ConfigurationParameters object.

Parameters:
paramsthe configuration parameters object with parameters to use
prefixthe prefix to use to access the object configuration parameters. This is guaranteed to end with the separator character when called by the factory, so you don't need to add one

Implements ParameterSettableWithConfigureFunction.

Definition at line 102 of file liboutputfunctions.cpp.

References ConfigurationParameters::getValue().

bool derivate ( const DoubleVector x,
const DoubleVector y,
DoubleVector d 
) const [virtual]

return always 1 (an explain of why will be coming soon)

Reimplemented from OutputFunction.

Definition at line 97 of file liboutputfunctions.cpp.

References DoubleVector::setAll().

void save ( ConfigurationParameters params,
QString  prefix 
) [virtual]

Save the actual status of parameters into the ConfigurationParameters object passed.

Parameters:
paramsthe configuration parameters object on which save actual parameters
prefixthe prefix to use to access the object configuration parameters.

Implements ParameterSettable.

Definition at line 115 of file liboutputfunctions.cpp.

References ConfigurationParameters::createParameter(), and ConfigurationParameters::startObjectParameters().


The documentation for this class was generated from the following files: