csl::Effect Class Reference

#include <CSL_Core.h>

Inheritance diagram for csl::Effect:

csl::UnitGenerator csl::Controllable csl::Model csl::BinaryOp csl::Clipper csl::Convolver csl::DelayLine csl::DelayLine csl::DynamicVariable csl::FanOut csl::FDN csl::FFT csl::Filter csl::FIR csl::Freeverb csl::InOut csl::Joiner csl::LPCAnalyzer csl::LPCFilter csl::Panner csl::RingBuffer csl::RtpSender csl::Stereoverb csl::StereoWidth csl::ThreadedReader

List of all members.

Public Member Functions

 Effect ()
 Constructors.
 Effect (UnitGenerator &input)
 use the given input
bool isActive ()
 query whether I'm currently active (Envelopes can go inactive)
void setInput (UnitGenerator &inp)
 set the receiver's input generator
void setInline ()
 set the Effect to be inline

Public Attributes

bool isInline
 whether to use input or buffer as source

Protected Member Functions

void pullInput (Buffer &outputBuffer) throw (CException)
void pullInput (unsigned numFrames) throw (CException)
PortinPort ()
 get the input port

Protected Attributes

SampleBuffer mInputPtr


Detailed Description

Effect -- mix-in for classes that have unit generators as inputs (like filters). Note that this always uses a separate buffer for the input.

Constructor & Destructor Documentation

Effect::Effect (  ) 

Constructors.

References isInline, and csl::logMsg().

Effect::Effect ( UnitGenerator input  ) 

use the given input

References csl::Controllable::addInput(), CSL_INPUT, isInline, and csl::logMsg().


Member Function Documentation

bool csl::Effect::isActive (  )  [inline, virtual]

query whether I'm currently active (Envelopes can go inactive)

Reimplemented from csl::UnitGenerator.

References CSL_INPUT, isActive(), and csl::Controllable::mInputs.

Referenced by isActive().

void Effect::setInput ( UnitGenerator inp  ) 

set the receiver's input generator

References csl::Controllable::addInput(), CSL_INPUT, isInline, and csl::logMsg().

Referenced by main().

void csl::Effect::setInline (  )  [inline]

set the Effect to be inline

References isInline.

void Effect::pullInput ( Buffer outputBuffer  )  throw (CException) [protected]

void Effect::pullInput ( unsigned  numFrames  )  throw (CException) [protected]

Port* csl::Effect::inPort (  )  [inline, protected]


Member Data Documentation

whether to use input or buffer as source

Referenced by Effect(), setInline(), and setInput().

A pointer to my input's data. method to read the input value


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

Generated on Thu Sep 17 23:14:17 2009 for CSL by  doxygen 1.5.8