CLAM::SimpleOscillator Class Reference

#include <SimpleOscillator.hxx>

Inheritance diagram for CLAM::SimpleOscillator:

Detailed Description

Definition at line 84 of file SimpleOscillator.hxx.


Public Member Functions
	SimpleOscillator ()
	SimpleOscillator (const SimpleOscillatorConfig &c)
virtual	~SimpleOscillator ()
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
virtual const ProcessingConfig &	GetConfig () const
	Configuration getter.
virtual bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
virtual bool	Do (void)
	Supervised mode execution method (using ports).
bool	Do (Audio &out)
bool	Do (TData &out)
	Do for generating one sample at a time: useful to use the oscillator as a LFO.
Protected Types
typedef InControlTmpl < SimpleOscillator >	SimpleOscillatorCtrl
Protected Member Functions
void	ApplyFreqAndAmpControls ()
int	UpdateFreq (TControlData)
int	UpdateAmp (TControlData)
Protected Attributes
AudioOutPort	mOutput
SimpleOscillatorConfig	mConfig
TData	mAmp
TData	mPhase
TData	mDeltaPhase
TData	mSamplingRate
bool	mFreqUpdated
bool	mAmpUpdated
SimpleOscillatorCtrl *	mFreqCtl
SimpleOscillatorCtrl *	mAmpCtl
InControl	mSamplesBetweenCallsCtl

Member Typedef Documentation

typedef InControlTmpl<SimpleOscillator> CLAM::SimpleOscillator::SimpleOscillatorCtrl [protected]

Definition at line 94 of file SimpleOscillator.hxx.

Constructor & Destructor Documentation

CLAM::SimpleOscillator::SimpleOscillator ( )

Definition at line 58 of file SimpleOscillator.cxx.

References CLAM::Processing::Configure(), mAmpCtl, mFreqCtl, UpdateAmp(), and UpdateFreq().

CLAM::SimpleOscillator::SimpleOscillator ( const SimpleOscillatorConfig & c )

Definition at line 75 of file SimpleOscillator.cxx.

References CLAM::Processing::Configure(), mAmpCtl, mFreqCtl, UpdateAmp(), and UpdateFreq().

CLAM::SimpleOscillator::~SimpleOscillator ( ) [virtual]

Definition at line 88 of file SimpleOscillator.cxx.

References mAmpCtl, and mFreqCtl.

Member Function Documentation

void CLAM::SimpleOscillator::ApplyFreqAndAmpControls ( ) [inline, protected]

Definition at line 105 of file SimpleOscillator.hxx.

References CLAM::InControl::GetLastValue(), mAmp, mAmpCtl, mAmpUpdated, mDeltaPhase, mFreqCtl, mFreqUpdated, mSamplingRate, and PI.

Referenced by Do().

int CLAM::SimpleOscillator::UpdateFreq ( TControlData value ) [protected]

Definition at line 152 of file SimpleOscillator.cxx.

References mFreqUpdated.

Referenced by SimpleOscillator().

int CLAM::SimpleOscillator::UpdateAmp ( TControlData value ) [protected]

Definition at line 159 of file SimpleOscillator.cxx.

References mAmpUpdated.

Referenced by SimpleOscillator().

const char* CLAM::SimpleOscillator::GetClassName ( ) const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Reimplemented in CLAM::Oscillator.

Definition at line 130 of file SimpleOscillator.hxx.

virtual const ProcessingConfig& CLAM::SimpleOscillator::GetConfig ( ) const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:: Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Reimplemented in CLAM::Oscillator.

Definition at line 132 of file SimpleOscillator.hxx.

References mConfig.

bool CLAM::SimpleOscillator::ConcreteConfigure ( const ProcessingConfig & ) [virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:

Reference

to the configuration object.

Returns:: false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:

This

method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Reimplemented in CLAM::Oscillator.

Definition at line 94 of file SimpleOscillator.cxx.

References CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl::DoControl(), mAmp, mConfig, mDeltaPhase, mPhase, mSamplesBetweenCallsCtl, mSamplingRate, and PI.