CLAM::TopLevelProcessing Class Reference

Top level processing object composite. More...

#include <TopLevelProcessing.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfig & GetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports).

Static Public Member Functions

static TopLevelProcessing & GetInstance ()
 Singleton accessor.

Protected Member Functions

bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method interface.

Detailed Description

Top level processing object composite.

This is a singleton class used to agregate all the horphan processing objects. It will allways be the upper composite object in the processing object hierarchy.

Definition at line 45 of file TopLevelProcessing.hxx.

Member Function Documentation

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

Implements CLAM::ProcessingComposite.

Definition at line 34 of file TopLevelProcessing.cxx.

References CLAM_ASSERT.

bool CLAM::TopLevelProcessing::Do ( void   )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 47 of file TopLevelProcessing.cxx.

References CLAM_ASSERT.

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

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

Reimplemented from CLAM::ProcessingComposite.

Definition at line 55 of file TopLevelProcessing.hxx.

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

Implements CLAM::ProcessingComposite.

Definition at line 60 of file TopLevelProcessing.hxx.

TopLevelProcessing & CLAM::TopLevelProcessing::GetInstance (  )  [static]

Singleton accessor.

Definition at line 40 of file TopLevelProcessing.cxx.

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