CLAM::IFFT_base Class Reference

Abstract base class for IFFT classes. More...

#include <IFFT_base.hxx>

List of all members.

Public Member Functions

 IFFT_base ()
virtual ~IFFT_base ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
virtual const ProcessingConfigGetConfig () const
 Config access:
virtual bool Do (void)=0
 Supervised-mode Do function.
virtual bool Do (const Spectrum &in, Audio &out) const =0
 Standard IFFT Do function, with storage class references as arguments.
virtual bool SetPrototypes (const Spectrum &in, const Audio &out)=0
 IFFT non-supervised mode SetPrototypes function.
virtual bool SetPrototypes ()
 Standard supervised-mode SetPrototypes function.
virtual bool UnsetPrototypes ()
 Standard UnsetPrototypes function.
virtual bool MayDisableExecution () const

Protected Types

enum  { CLAM_DEFAULT_IFFT_SIZE = 1024 }

Protected Member Functions

void ChangeSize (int n)
int GetSize ()
virtual bool ConcreteConfigure (const ProcessingConfig &)=0
 Configuration method interface.

Protected Attributes

IFFTConfig mConfig
 IFFT Configuration.
int mSize
 IFFT size.
InPort< SpectrummInput
AudioOutPort mOutput

Detailed Description

Abstract base class for IFFT classes.

Definition at line 42 of file IFFT_base.hxx.


Member Enumeration Documentation

anonymous enum [protected]
Enumerator:
CLAM_DEFAULT_IFFT_SIZE 

Definition at line 45 of file IFFT_base.hxx.


Constructor & Destructor Documentation

CLAM::IFFT_base::IFFT_base (  ) 

Definition at line 30 of file IFFT_base.cxx.

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

Definition at line 37 of file IFFT_base.cxx.


Member Function Documentation

void CLAM::IFFT_base::ChangeSize ( int  n  )  [protected]

Definition at line 41 of file IFFT_base.cxx.

References CLAM_ASSERT.

virtual bool CLAM::IFFT_base::ConcreteConfigure ( const ProcessingConfig  )  [protected, pure 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.

virtual bool CLAM::IFFT_base::Do ( const Spectrum in,
Audio out 
) const [pure virtual]

Standard IFFT Do function, with storage class references as arguments.

This method implements the old conversor routines.

Implemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

virtual bool CLAM::IFFT_base::Do ( void   )  [pure virtual]

Supervised-mode Do function.

Implements CLAM::Processing.

Implemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

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

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

Implements CLAM::Processing.

Reimplemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

Definition at line 67 of file IFFT_base.hxx.

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

Config access:

Reimplemented from CLAM::Processing.

Definition at line 71 of file IFFT_base.hxx.

References mConfig.

int CLAM::IFFT_base::GetSize (  )  [inline, protected]

Definition at line 57 of file IFFT_base.hxx.

References mSize.

virtual bool CLAM::IFFT_base::MayDisableExecution (  )  const [inline, virtual]

Reimplemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

Definition at line 97 of file IFFT_base.hxx.

virtual bool CLAM::IFFT_base::SetPrototypes (  )  [inline, virtual]

Standard supervised-mode SetPrototypes function.

Reimplemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

Definition at line 88 of file IFFT_base.hxx.

virtual bool CLAM::IFFT_base::SetPrototypes ( const Spectrum in,
const Audio out 
) [pure virtual]

IFFT non-supervised mode SetPrototypes function.

Implemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

virtual bool CLAM::IFFT_base::UnsetPrototypes (  )  [inline, virtual]

Standard UnsetPrototypes function.

Reimplemented in CLAM::IFFT_fftw3, and CLAM::IFFT_ooura.

Definition at line 91 of file IFFT_base.hxx.


Member Data Documentation

IFFT Configuration.

Definition at line 48 of file IFFT_base.hxx.

Referenced by GetConfig().

Definition at line 52 of file IFFT_base.hxx.

Referenced by CLAM::IFFT_ooura::Do(), and CLAM::IFFT_fftw3::SetPrototypes().

Definition at line 53 of file IFFT_base.hxx.

Referenced by CLAM::IFFT_ooura::Do(), and CLAM::IFFT_fftw3::SetPrototypes().

IFFT size.

Definition at line 50 of file IFFT_base.hxx.

Referenced by GetSize().


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