csl::Controllable Class Reference

#include <CSL_Core.h>

Inheritance diagram for csl::Controllable:

List of all members.

Public Member Functions

Controllable ()

virtual ~Controllable ()

Constructor takes no arguments.

Protected Member Functions

void addInput (CSL_MAP_KEY name, UnitGenerator &ugen)

Plug in a unit generator to the named input slot.

void addInput (CSL_MAP_KEY name, float value)

Plug in a float to the named input slot.

void pullInput (Port *thePort, unsigned numFrames) throw (CException)

void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)

virtual void dump ()

pretty-print the receiver's input/controls map

Protected Attributes

PortMap mInputs

Destructor (ought to remove the output links of the ports).

Detailed Description

Controllable -- superclass of the mix-ins that add control or signal inputs. This holds onto a map of port objects that represent the inputs, and manages the naming and processing flow for dynamic inputs.

A typical complex UGen will have several ports, e.g., for frequency, scale, and offset in the case of an oscillator that supports AM and FM. The pullInput() message is used to call the nextBuffer() method of a given port.

Constructor & Destructor Documentation

csl::Controllable::Controllable ( ) [inline]

virtual csl::Controllable::~Controllable ( ) [inline, virtual]

Constructor takes no arguments.

Member Function Documentation

void Controllable::addInput	(	CSL_MAP_KEY	name,
		UnitGenerator &	ugen
	)			`[protected]`

void Controllable::addInput	(	CSL_MAP_KEY	name,
		float	value
	)			`[protected]`

Plug in a float to the named input slot.

References csl::logMsg(), mInputs, and csl::Port::mValue.

void Controllable::pullInput	(	Port *	thePort,
		unsigned	numFrames
	)			throw (CException) `[protected]`

method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.

References csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, csl::Buffer::mType, and csl::UnitGenerator::nextBuffer().

Referenced by csl::DelayLine::nextBuffer(), csl::NtoMPanner::nextBuffer(), csl::Panner::nextBuffer(), and csl::Effect::pullInput().

void Controllable::pullInput	(	Port *	thePort,
		Buffer &	theBuffer
	)			throw (CException) `[protected]`

References csl::UnitGenerator::nextBuffer().

void Controllable::dump ( void ) [protected, virtual]

pretty-print the receiver's input/controls map

Reimplemented in csl::Abst_SoundFile, csl::CASoundFile, csl::BinaryOp, csl::Clipper, csl::Filter, csl::Mixer, csl::Envelope, csl::RandEnvelope, csl::KarplusString, csl::Noise, csl::Oscillator, csl::SumOfSines, csl::SineAsPhased, csl::SineAsScaled, and csl::SpatialSource.

References CSL_FREQUENCY, CSL_INPUT, CSL_OFFSET, CSL_SCALE, csl::logMsg(), and mInputs.

Member Data Documentation

PortMap csl::Controllable::mInputs [protected]

Destructor (ought to remove the output links of the ports).

the map of my inputs or controls (used by the mix-in classes)

Reimplemented in csl::Joiner.

Referenced by addInput(), csl::BinaryOp::dump(), dump(), csl::Effect::inPort(), csl::Effect::isActive(), csl::SquareBL::nextWaveInto(), csl::BinaryOp::operandIsFixed(), csl::Phased::Phased(), csl::DistanceSimulator::positionChanged(), csl::Scalable::Scalable(), csl::Abst_SoundFile::setRate(), csl::Moog::setupCoeffs(), csl::Allpass::setupCoeffs(), csl::Notch::setupCoeffs(), csl::Formant::setupCoeffs(), and csl::Butter::setupCoeffs().

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

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


Public Member Functions
	Controllable ()
virtual	~Controllable ()
	Constructor takes no arguments.
Protected Member Functions
void	addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
	Plug in a unit generator to the named input slot.
void	addInput (CSL_MAP_KEY name, float value)
	Plug in a float to the named input slot.
void	pullInput (Port *thePort, unsigned numFrames) throw (CException)
void	pullInput (Port *thePort, Buffer &theBuffer) throw (CException)
virtual void	dump ()
	pretty-print the receiver's input/controls map
Protected Attributes
PortMap	mInputs
	Destructor (ought to remove the output links of the ports).