csl::Effect Class Reference

#include <CSL_Core.h>

Inheritance diagram for csl::Effect:

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)
Port *	inPort ()
	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]

References CSL_INPUT, csl::logMsg(), and csl::Controllable::pullInput().

Referenced by csl::ThreadedReader::nextBuffer(), csl::LPCFilter::nextBuffer(), csl::LPCAnalyzer::nextBuffer(), csl::Convolver::nextBuffer(), csl::StereoWidth::nextBuffer(), csl::NtoMPanner::nextBuffer(), csl::Panner::nextBuffer(), csl::InOut::nextBuffer(), csl::Filter::nextBuffer(), csl::RingBuffer::nextBuffer(), csl::Splitter::nextBuffer(), csl::FanOut::nextBuffer(), and csl::ThreadedReader::readIntoBuffer().

void Effect::pullInput

(

unsigned

numFrames

)

throw (CException) [protected]

References CSL_INPUT, csl::logMsg(), csl::Port::mBuffer, csl::Buffer::mBuffers, and csl::Controllable::pullInput().

Port* csl::Effect::inPort

(

)

[inline, protected]

get the input port

References CSL_INPUT, and csl::Controllable::mInputs.

Referenced by csl::BinaryOp::dump(), csl::BinaryOp::inputIsFixed(), and csl::LPCAnalyzer::nextBuffer().

---

Member Data Documentation

bool csl::Effect::isInline

whether to use input or buffer as source

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

SampleBuffer csl::Effect::mInputPtr [protected]

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

---

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

• CSL/Kernel/CSL_Core.h
• CSL/Kernel/CSL_Core.cpp