CLAM::Oscillator Class Reference

#include <Oscillator.hxx>

List of all members.

Public Member Functions
	Oscillator (const Config &c=Config())
virtual	~Oscillator ()
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (Audio &out)
bool	Do (const Audio &pitchModIn, const Audio &phaseModIn, Audio &out)
bool	Do (const Audio &pitchModIn, const int &dum, Audio &out)
bool	Do (const int &dum, const Audio &phaseModIn, Audio &out)

---

Detailed Description

Definition at line 49 of file Oscillator.hxx.

---

Constructor & Destructor Documentation

CLAM::Oscillator::Oscillator

(

const Config &

c = Config()

)

CLAM::Oscillator::~Oscillator

(

)

[virtual]

Definition at line 73 of file Oscillator.cxx.

---

Member Function Documentation

bool CLAM::Oscillator::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::SimpleOscillator.

Definition at line 77 of file Oscillator.cxx.

References CLAM::Processing::CopyAsConcreteConfig(), CLAM::SimpleOscillator::mAmp, CLAM::SimpleOscillator::mDeltaPhase, CLAM::SimpleOscillator::mPhase, CLAM::SimpleOscillator::mSamplingRate, and PI.

bool CLAM::Oscillator::Do	(	const int &	dum,
		const Audio &	phaseModIn,
		Audio &	out
	)

Definition at line 148 of file Oscillator.cxx.

References CLAM::Processing::AbleToExecute(), CLAM::Audio::GetSize(), CLAM::SimpleOscillator::mAmp, CLAM::SimpleOscillator::mDeltaPhase, CLAM::SimpleOscillator::mPhase, and PI.

bool CLAM::Oscillator::Do	(	const Audio &	pitchModIn,
		const int &	dum,
		Audio &	out
	)

Definition at line 125 of file Oscillator.cxx.

References CLAM::Processing::AbleToExecute(), CLAM::Audio::GetSize(), CLAM::SimpleOscillator::mAmp, CLAM::SimpleOscillator::mDeltaPhase, CLAM::SimpleOscillator::mPhase, and PI.

bool CLAM::Oscillator::Do	(	const Audio &	pitchModIn,
		const Audio &	phaseModIn,
		Audio &	out
	)

Definition at line 100 of file Oscillator.cxx.

References CLAM::Processing::AbleToExecute(), CLAM::Audio::GetSize(), CLAM::SimpleOscillator::mAmp, CLAM::SimpleOscillator::mDeltaPhase, CLAM::SimpleOscillator::mPhase, and PI.

bool CLAM::Oscillator::Do

(

Audio &

out

)

[inline]

Reimplemented from CLAM::SimpleOscillator.

Definition at line 83 of file Oscillator.hxx.

References Do().

bool CLAM::Oscillator::Do

(

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Reimplemented from CLAM::SimpleOscillator.

Definition at line 91 of file Oscillator.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioOutPort::GetAudio(), CLAM::AudioInPort::GetAudio(), CLAM::SimpleOscillator::mOutput, and CLAM::OutPort< Token >::Produce().

Referenced by Do().

const char* CLAM::Oscillator::GetClassName

(

)

const [inline, virtual]

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

Reimplemented from CLAM::SimpleOscillator.

Definition at line 79 of file Oscillator.hxx.

const ProcessingConfig& CLAM::Oscillator::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::SimpleOscillator.

Definition at line 80 of file Oscillator.hxx.

---

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

• Oscillator.hxx
• Oscillator.cxx