CLAM::Dispatcher Class Reference
#include <Dispatcher.hxx>
Detailed Description
Definition at line 49 of file Dispatcher.hxx.
Public Member Functions | |
| Dispatcher () | |
| Dispatcher (const DispatcherConfig &c) | |
| ~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 | |
| int | UpdateState (TControlData availableInstr) |
| int | UpdateVel (TControlData value) |
| int | UpdateNote (TControlData value) |
| void | Dispatch (void) |
Classes | |
| struct | InstrStatus |
Constructor & Destructor Documentation
| CLAM::Dispatcher::Dispatcher | ( | ) | [inline] |
| CLAM::Dispatcher::Dispatcher | ( | const DispatcherConfig & | c | ) | [inline] |
| CLAM::Dispatcher::~Dispatcher | ( | ) | [inline] |
Definition at line 119 of file Dispatcher.hxx.
Member Function Documentation
| int Dispatcher::UpdateState | ( | TControlData | availableInstr | ) | [protected] |
Definition at line 60 of file Dispatcher.cxx.
| int CLAM::Dispatcher::UpdateVel | ( | TControlData | value | ) | [inline, protected] |
Definition at line 76 of file Dispatcher.hxx.
| int CLAM::Dispatcher::UpdateNote | ( | TControlData | value | ) | [inline, protected] |
| void Dispatcher::Dispatch | ( | void | ) | [protected] |
| 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 121 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 123 of file Dispatcher.hxx.
| 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)
- 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::OutControl::AddLink(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::OutControlRegistry::GetByNumber(), CLAM::Processing::GetInControls(), and CLAM::Processing::GetOutControls().
| 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 127 of file Dispatcher.hxx.
The documentation for this class was generated from the following files:
