CSL  5.2
csl::FrequencyAmount Class Reference

FrequencyAmount – mix-in class with frequency and amount (BW) control inputs (may be constants or generators). amount (probably 0..1) is a generalised placeholder for bandwidth, resonance or radius, according to filter type or could equally be used as a kind of x,y location in the frequency domain. More...

#include <Filters.h>

+ Inheritance diagram for csl::FrequencyAmount:

List of all members.

Public Member Functions

 FrequencyAmount ()
 Constructors.
 ~FrequencyAmount ()
 Destructor.
void setFrequency (UnitGenerator &frequency)
 set the receiver's frequency to a UGen or a float
void setFrequency (float frequency)
float getFrequency ()
void setAmount (UnitGenerator &amount)
 set the receiver's amount to a UGen or a float
void setAmount (float amount)
PortgetPort (CSL_MAP_KEY name)

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)
 method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.
void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)
virtual void dump ()
 pretty-print the receiver's input/controls map

Protected Attributes

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

Detailed Description

FrequencyAmount – mix-in class with frequency and amount (BW) control inputs (may be constants or generators). amount (probably 0..1) is a generalised placeholder for bandwidth, resonance or radius, according to filter type or could equally be used as a kind of x,y location in the frequency domain.

Definition at line 70 of file Filters.h.


Constructor & Destructor Documentation

FrequencyAmount::FrequencyAmount ( )

Constructors.

Definition at line 17 of file Filters.cpp.

References csl::logMsg().

FrequencyAmount::~FrequencyAmount ( )

Destructor.

Definition at line 23 of file Filters.cpp.


Member Function Documentation

void FrequencyAmount::setFrequency ( UnitGenerator frequency)
void FrequencyAmount::setFrequency ( float  frequency)

Definition at line 34 of file Filters.cpp.

References csl::Controllable::addInput(), CSL_FILTER_FREQUENCY, and csl::logMsg().

float FrequencyAmount::getFrequency ( )

Definition at line 41 of file Filters.cpp.

References CSL_FILTER_FREQUENCY, and csl::Controllable::getPort().

void FrequencyAmount::setAmount ( UnitGenerator amount)

set the receiver's amount to a UGen or a float

Definition at line 45 of file Filters.cpp.

References csl::Controllable::addInput(), CSL_FILTER_AMOUNT, and csl::logMsg().

Referenced by csl::Allpass::Allpass(), csl::Butter::Butter(), csl::Formant::Formant(), csl::Moog::Moog(), and csl::Notch::Notch().

void FrequencyAmount::setAmount ( float  amount)

Definition at line 52 of file Filters.cpp.

References csl::Controllable::addInput(), CSL_FILTER_AMOUNT, and csl::logMsg().

Port * Controllable::getPort ( CSL_MAP_KEY  name)
inherited

Definition at line 768 of file CSL_Core.cpp.

References csl::Controllable::mInputs.

Referenced by getFrequency(), and csl::VSTIO::getParameter().

void Controllable::addInput ( CSL_MAP_KEY  name,
float  value 
)
protectedinherited

Plug in a float to the named input slot.

Definition at line 754 of file CSL_Core.cpp.

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

void Controllable::pullInput ( Port thePort,
unsigned  numFrames 
) throw (CException)
protectedinherited

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

Definition at line 695 of file CSL_Core.cpp.

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

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

void Controllable::pullInput ( Port thePort,
Buffer theBuffer 
) throw (CException)
protectedinherited

Definition at line 727 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void Controllable::dump ( void  )
protectedvirtualinherited

Member Data Documentation


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