CLAM::EnvelopeModulator Class Reference

#include <EnvelopeModulator.hxx>

List of all members.

Public Member Functions

 EnvelopeModulator (const EnvModulatorConfig &c=EnvModulatorConfig())
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
void Attach (Envelope &env, Audio &inp, Audio &out)
bool Do (void)
 Supervised mode execution method (using ports).
bool Do (const Envelope &env, const Audio &inp, Audio &out)

Public Attributes

InPort< EnvelopeInputEnvelope
InPort< AudioInputAudio
OutPort< AudioOutput

Detailed Description

Definition at line 47 of file EnvelopeModulator.hxx.

Constructor & Destructor Documentation

CLAM::EnvelopeModulator::EnvelopeModulator ( const EnvModulatorConfig c = EnvModulatorConfig()  ) 

Definition at line 35 of file EnvelopeModulator.cxx.

Member Function Documentation

void CLAM::EnvelopeModulator::Attach ( Envelope env,
Audio inp,
Audio out 
bool CLAM::EnvelopeModulator::Do ( const Envelope env,
const Audio inp,
Audio out 

Definition at line 76 of file EnvelopeModulator.cxx.

bool CLAM::EnvelopeModulator::Do ( void   )  [virtual]

Supervised mode execution method (using ports).

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 65 of file EnvelopeModulator.cxx.

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

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

Implements CLAM::Processing.

Definition at line 67 of file EnvelopeModulator.hxx.

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

Configuration getter.

Gets the configuration parameters used to create the object.

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.

Definition at line 69 of file EnvelopeModulator.hxx.

Member Data Documentation

Definition at line 52 of file EnvelopeModulator.hxx.

Definition at line 51 of file EnvelopeModulator.hxx.

Definition at line 53 of file EnvelopeModulator.hxx.

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3