CLAM::OutControlSender Class Reference

#include <OutControlSender.hxx>

List of all members.

Public Types

typedef OutControlSenderConfig Config

Public Member Functions

 OutControlSender (const Config &=Config())
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.
void SendControl (TControlData value)

Protected Member Functions

bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.

Detailed Description

Definition at line 79 of file OutControlSender.hxx.

Member Typedef Documentation

typedef OutControlSenderConfig CLAM::OutControlSender::Config

Reimplemented from CLAM::Processing.

Definition at line 86 of file OutControlSender.hxx.

Constructor & Destructor Documentation

CLAM::OutControlSender::OutControlSender ( const Config &  = Config()  ) 

Member Function Documentation

bool CLAM::OutControlSender::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 83 of file OutControlSender.cxx.

bool CLAM::OutControlSender::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 60 of file OutControlSender.cxx.

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

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 66 of file OutControlSender.cxx.

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

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

Implements CLAM::Processing.

Definition at line 90 of file OutControlSender.hxx.

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

void CLAM::OutControlSender::SendControl ( TControlData  value  ) 

Definition at line 76 of file OutControlSender.cxx.

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