CLAM::LadspaWrapper Class Reference

#include <LadspaWrapper.hxx>

List of all members.

Public Member Functions

 LadspaWrapper (const Config &c=Config())
 LadspaWrapper (const std::string &libraryFileName, unsigned index, const std::string &factoryKey)
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 &)
 Configuration method interface.
bool Do ()
 Supervised mode execution method (using ports).
virtual ~LadspaWrapper ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool LoadLibraryFunction (const std::string &libraryFileName, unsigned index, const std::string &factoryKey)

Detailed Description

Definition at line 14 of file LadspaWrapper.hxx.


Constructor & Destructor Documentation

CLAM::LadspaWrapper::LadspaWrapper ( const Config c = Config()  ) 
CLAM::LadspaWrapper::LadspaWrapper ( const std::string &  libraryFileName,
unsigned  index,
const std::string &  factoryKey 
)
virtual CLAM::LadspaWrapper::~LadspaWrapper (  )  [virtual]

Member Function Documentation

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

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

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

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

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

const char* CLAM::LadspaWrapper::GetClassName (  )  const [virtual]

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

Implements CLAM::Processing.

bool CLAM::LadspaWrapper::LoadLibraryFunction ( const std::string &  libraryFileName,
unsigned  index,
const std::string &  factoryKey 
)

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