CLAM::TonalAnalysis Class Reference

#include <TonalAnalysis.hxx>

List of all members.

Public Member Functions

 TonalAnalysis (const TonalAnalysisConfig &config=TonalAnalysisConfig())
bool Do ()
 Supervised mode execution method (using ports).
virtual ~TonalAnalysis ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfig & GetConfig () const
 Configuration getter.
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.

Detailed Description

Definition at line 32 of file TonalAnalysis.hxx.

Constructor & Destructor Documentation

CLAM::TonalAnalysis::TonalAnalysis ( const TonalAnalysisConfig &  config = TonalAnalysisConfig()  ) 

Definition at line 53 of file TonalAnalysis.cxx.

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

Definition at line 66 of file TonalAnalysis.cxx.

Member Function Documentation

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

Definition at line 71 of file TonalAnalysis.cxx.

bool CLAM::TonalAnalysis::ConcreteStart ( void   )  [virtual]

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:
Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 91 of file TonalAnalysis.cxx.

bool CLAM::TonalAnalysis::ConcreteStop (  )  [virtual]

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.

Returns:
Whether stop changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 97 of file TonalAnalysis.cxx.

bool CLAM::TonalAnalysis::Do (  )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 103 of file TonalAnalysis.cxx.

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

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

Implements CLAM::Processing.

Definition at line 49 of file TonalAnalysis.hxx.

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

Definition at line 51 of file TonalAnalysis.hxx.

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