CLAM::Fundamental2Control Class Reference

#include <Fundamental2Control.hxx>

List of all members.

Public Member Functions

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

Detailed Description

Definition at line 43 of file Fundamental2Control.hxx.

Constructor & Destructor Documentation

CLAM::Fundamental2Control::Fundamental2Control (  )  [inline]

Definition at line 57 of file Fundamental2Control.hxx.

References CLAM::Processing::Configure().

CLAM::Fundamental2Control::Fundamental2Control ( const Fundamental2ControlConfig &  cfg  )  [inline]

Definition at line 65 of file Fundamental2Control.hxx.

References CLAM::Processing::Configure().

Member Function Documentation

bool CLAM::Fundamental2Control::ConcreteConfigure ( const ProcessingConfig &   )  [inline, 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 73 of file Fundamental2Control.hxx.

bool CLAM::Fundamental2Control::Do ( const Fundamental &  inFund  ) 

Definition at line 14 of file Fundamental2Control.cxx.

bool CLAM::Fundamental2Control::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 77 of file Fundamental2Control.hxx.

References CLAM::InPort< Token >::Consume(), and CLAM::InPort< Token >::GetData().

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

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

Implements CLAM::Processing.

Definition at line 54 of file Fundamental2Control.hxx.

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

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