CLAM::Dispatcher Class Reference

#include <Dispatcher.hxx>

List of all members.

Classes

struct  InstrStatus

Public Member Functions

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

Protected Member Functions

void UpdateState (TControlData availableInstr)
void UpdateVel (TControlData value)
void UpdateNote (TControlData value)
void Dispatch (void)

Detailed Description

Definition at line 49 of file Dispatcher.hxx.

Constructor & Destructor Documentation

CLAM::Dispatcher::Dispatcher ( const Config &  c = Config()  )  [inline]

Definition at line 93 of file Dispatcher.hxx.

References CLAM::Processing::Configure().

CLAM::Dispatcher::~Dispatcher (  )  [inline]

Definition at line 103 of file Dispatcher.hxx.

Member Function Documentation

bool Dispatcher::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 26 of file Dispatcher.cxx.

References CLAM::Array< T >::AddElem(), CLAM::OutControlBase::AddLink(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::Processing::GetInControl(), CLAM::Processing::GetOutControl(), and CLAM::Array< T >::Size().

void Dispatcher::Dispatch ( void   )  [protected]

Definition at line 75 of file Dispatcher.cxx.

Referenced by UpdateNote().

bool CLAM::Dispatcher::Do ( void   )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 111 of file Dispatcher.hxx.

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

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

Implements CLAM::Processing.

Definition at line 105 of file Dispatcher.hxx.

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

void CLAM::Dispatcher::UpdateNote ( TControlData  value  )  [inline, protected]

Definition at line 83 of file Dispatcher.hxx.

References Dispatch().

void Dispatcher::UpdateState ( TControlData  availableInstr  )  [protected]

Definition at line 60 of file Dispatcher.cxx.

void CLAM::Dispatcher::UpdateVel ( TControlData  value  )  [inline, protected]

Definition at line 77 of file Dispatcher.hxx.

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