CLAM::ZeroPadder Class Reference

#include <ZeroPadder.hxx>

Inheritance diagram for CLAM::ZeroPadder:

Detailed Description

Definition at line 39 of file ZeroPadder.hxx.


Public Member Functions
	ZeroPadder ()
virtual	~ZeroPadder ()
bool	Do ()
	Supervised mode execution method (using ports).
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
Protected Member Functions
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.
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
Protected Attributes
ZeroPadderConfig	mConfig
AudioInPort	mInput
AudioOutPort	mOutput

Constructor & Destructor Documentation

CLAM::ZeroPadder::ZeroPadder ( )

Definition at line 26 of file ZeroPadder.cxx.

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

Definition at line 32 of file ZeroPadder.cxx.

Member Function Documentation

bool CLAM::ZeroPadder::ConcreteStart ( void ) [protected, 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 43 of file ZeroPadder.cxx.

bool CLAM::ZeroPadder::ConcreteStop ( ) [protected, 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 48 of file ZeroPadder.cxx.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 53 of file ZeroPadder.cxx.

References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::AudioOutPort::GetAudio(), CLAM::AudioInPort::GetAudio(), mInput, and mOutput.

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

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

Implements CLAM::Processing.

Definition at line 57 of file ZeroPadder.hxx.

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

References mConfig.

bool CLAM::ZeroPadder::ConcreteConfigure ( const ProcessingConfig & ) [protected, 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 36 of file ZeroPadder.cxx.

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