RCKit
Public Member Functions
Linear Class Reference

Setter class that implements linear transform of its input value. More...

#include <Linear.h>

Inheritance diagram for Linear:
Inheritance graph
[legend]
Collaboration diagram for Linear:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Linear (float gain, int offset)
virtual void input (int value)
- Public Member Functions inherited from Setter
 Setter ()
 Constructor.
 Setter (Setter *target)
 Constructor with setting the target.
virtual void setTarget (Setter *target)
virtual void failsafe ()
void setFailsafeValue (int failsafeValue)
 Sets the failsafeValue.
int failsafeValue ()

Additional Inherited Members

- Protected Attributes inherited from Setter
Setter_target
 This is the instance of Setter that will be given the transfotmed output value.
int _failsafeValue

Detailed Description

Setter class that implements linear transform of its input value.

Author:
Mike McCauley (mikem.nosp@m.@air.nosp@m.spayc.nosp@m.e.co.nosp@m.m)

Linear implements a y = mx + x linear transform of the input value. The resulting output value is sent to the next Setter (the target) in the chain.

Examples:
TestSuite.pde.

Constructor & Destructor Documentation

Linear::Linear ( float  gain,
int  offset 
)

Constructor. Output will be calculated according to out = (in * gain) + offset

Author:
Mike McCauley (mikem.nosp@m.@air.nosp@m.spayc.nosp@m.e.co.nosp@m.m)

Member Function Documentation

void Linear::input ( int  value)
virtual

Input the value to be transformed

Parameters:
[in]valueThe input value

Reimplemented from Setter.


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