CLAM::EnvelopeGenerator Class Reference

#include <EnvelopeGenerator.hxx>

List of all members.

Public Member Functions

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

Public Attributes

InPort< EnvelopeInput
AudioOutPort Output

Detailed Description

Definition at line 58 of file EnvelopeGenerator.hxx.

Constructor & Destructor Documentation

CLAM::EnvelopeGenerator::EnvelopeGenerator ( const EnvelopeGeneratorConfig c = EnvelopeGeneratorConfig()  )  [inline]

Definition at line 75 of file EnvelopeGenerator.hxx.

References CLAM::Processing::Configure().

Member Function Documentation

void CLAM::EnvelopeGenerator::Attach ( Envelope in,
Audio out 
) [inline]

Definition at line 105 of file EnvelopeGenerator.hxx.

References Input, and Output.

bool CLAM::EnvelopeGenerator::ConcreteConfigure ( const ProcessingConfig  )  [inline, 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.

Reference to the configuration object.
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.

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

Reimplemented from CLAM::Processing.

Definition at line 92 of file EnvelopeGenerator.hxx.

References CLAM::Processing::CopyAsConcreteConfig(), and Output.

bool CLAM::EnvelopeGenerator::Do ( Envelope in,
Audio out 
) [inline]
bool CLAM::EnvelopeGenerator::Do ( void   )  [inline, virtual]

Supervised mode execution method (using ports).

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 111 of file EnvelopeGenerator.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::OutPort< Token >::GetData(), CLAM::InPort< Token >::GetData(), Input, Output, and CLAM::OutPort< Token >::Produce().

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

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

Implements CLAM::Processing.

Definition at line 84 of file EnvelopeGenerator.hxx.

const ProcessingConfig& CLAM::EnvelopeGenerator::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 90 of file EnvelopeGenerator.hxx.

Member Data Documentation

Definition at line 86 of file EnvelopeGenerator.hxx.

Referenced by Attach(), and Do().

Definition at line 88 of file EnvelopeGenerator.hxx.

Referenced by Attach(), ConcreteConfigure(), and Do().

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