Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Function Class Reference

#include <Function.h>

Inheritance diagram for Function:

Stk BowTable JetTable ReedTable Table List of all members.

Detailed Description

STK abstract function parent class.

This class provides common functionality for STK classes which implement tables or other types of input to output function mappings.

by Perry R. Cook and Gary P. Scavone, 1995 - 2004.

Definition at line 18 of file Function.h.

Public Member Functions

 Function ()
 Class constructor.

virtual ~Function ()
 Class destructor.

virtual StkFloat lastOut () const
 Return the last output value.

virtual StkFloat tick (StkFloat input)=0
 Abstract tick function ... must be implemented in subclasses.

virtual StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Take vectorSize inputs from vector and replace them with corresponding outputs.

virtual StkFramestick (StkFrames &frames, unsigned int channel=1)
 Take a channel of the StkFrames object as inputs to the function and replace with corresponding outputs.


Member Function Documentation

virtual StkFrames& Function::tick StkFrames frames,
unsigned int  channel = 1
[virtual]
 

Take a channel of the StkFrames object as inputs to the function and replace with corresponding outputs.

The channel argument should be one or greater (the first channel is specified by 1). An StkError will be thrown if the channel argument is zero or it is greater than the number of channels in the StkFrames object.

Reimplemented in BowTable, JetTable, ReedTable, and Table.


The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.