PeriodicFunction Class Reference

PeriodicFunction. More...

Inheritance diagram for PeriodicFunction:

Inheritance graph
[legend]
Collaboration diagram for PeriodicFunction:

Collaboration graph
[legend]
List of all members.

Constructors

 PeriodicFunction (Real phase=0.0, Real span=1.0, Real amplitude=1.0)
 PeriodicFunction (PropertySettings &prop)
virtual ~PeriodicFunction ()

Interface

bool setPhase (const Variant &v)
Variant phase ()
bool setSpan (const Variant &v)
Variant span ()
bool setAmplitude (const Variant &v)
Variant amplitude ()
virtual void apply (RealVec &inputs, RealVec &outputs)=0
virtual PeriodicFunctionclone () const=0

Detailed Description

Properties
Name Type [isVector] Access mode Description Class
typename string read-only Class's type Propertized
phase Real read/write X offset of the centre this
span Real read/write distance between peaks this
amplitude Real read/write nonnegative value of the wave's magnitude this


Constructor & Destructor Documentation

PeriodicFunction ( Real  phase = 0.0,
Real  span = 1.0,
Real  amplitude = 1.0 
)

Construct

PeriodicFunction ( PropertySettings prop  ) 

Construct

virtual ~PeriodicFunction (  )  [inline, virtual]

Destructor


Member Function Documentation

bool setPhase ( const Variant v  ) 

Set the phase

Variant phase (  ) 

Return the phase

bool setSpan ( const Variant v  ) 

Set the span

Variant span (  ) 

Return the variance

bool setAmplitude ( const Variant v  ) 

Set the Amplitude

Variant amplitude (  ) 

Return the Max

virtual void apply ( RealVec inputs,
RealVec outputs 
) [pure virtual]

Implement the Sawtooth function

Reimplemented from OutputFunction.

Implemented in SawtoothFunction, TriangleFunction, SinFunction, and PseudoGaussFunction.

virtual PeriodicFunction* clone (  )  const [pure virtual]

Clone this object

Reimplemented from OutputFunction.

Implemented in SawtoothFunction, TriangleFunction, SinFunction, and PseudoGaussFunction.


The documentation for this class was generated from the following file:
BerliOS Developer Logo Valid XHTML 1.0 Transitional Valid CSS!