CLAM::ControlFade Class Reference

#include <ControlFade.hxx>

Inheritance diagram for CLAM::ControlFade:

List of all members.

Public Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
	ControlFade ()
	ControlFade (const ControlFadeConfig &cfg)
bool	ConcreteConfigure (const ProcessingConfig &cfg)
	Configuration method interface.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do ()
	Supervised mode execution method (using ports).

---

Detailed Description

Definition at line 44 of file ControlFade.hxx.

---

Constructor & Destructor Documentation

CLAM::ControlFade::ControlFade

(

)

Definition at line 23 of file ControlFade.cxx.

References CLAM::Processing::Configure().

CLAM::ControlFade::ControlFade

(

const ControlFadeConfig &

cfg

)

Definition at line 36 of file ControlFade.cxx.

References CLAM::Processing::Configure().

---

Member Function Documentation

const char* CLAM::ControlFade::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 60 of file ControlFade.hxx.

bool CLAM::ControlFade::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 49 of file ControlFade.cxx.

References CLAM::Processing::BackendBufferSize(), CLAM::Processing::BackendSampleRate(), CLAM::Processing::CopyAsConcreteConfig(), and CLAM::InControl< ControlDataType >::DoControl().

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

bool CLAM::ControlFade::Do

(

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 71 of file ControlFade.cxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), and CLAM::OutControl< ControlDataType >::SendControl().

---

The documentation for this class was generated from the following files:

• ControlFade.hxx
• ControlFade.cxx