CLAM::BinaryControlOp< BinOp > Class Template Reference
#include <BinaryControlOp.hxx>
Public Types | |
| typedef BinaryControlOpConfig | Config |
Public Member Functions | |
| BinaryControlOp (const BinaryControlOpConfig &cfg=Config()) | |
| bool | ConcreteConfigure (const ProcessingConfig &c) |
| Configuration method interface. | |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| TControlData | DoOperation () |
| bool | Do () |
| Supervised mode execution method (using ports). | |
| template<> | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
Public Attributes | |
| FloatInControl | mFirst |
| FloatInControl | mSecond |
Detailed Description
template<typename BinOp>
class CLAM::BinaryControlOp< BinOp >
Definition at line 49 of file BinaryControlOp.hxx.
Member Typedef Documentation
| typedef BinaryControlOpConfig CLAM::BinaryControlOp< BinOp >::Config |
Constructor & Destructor Documentation
| CLAM::BinaryControlOp< BinOp >::BinaryControlOp | ( | const BinaryControlOpConfig & | cfg = Config() |
) | [inline] |
Member Function Documentation
| bool CLAM::BinaryControlOp< BinOp >::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)
- 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 91 of file BinaryControlOp.hxx.
References CLAM::Processing::CopyAsConcreteConfig().
| const ProcessingConfig& CLAM::BinaryControlOp< BinOp >::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 97 of file BinaryControlOp.hxx.
| TControlData CLAM::BinaryControlOp< BinOp >::DoOperation | ( | ) | [inline] |
Definition at line 99 of file BinaryControlOp.hxx.
| bool CLAM::BinaryControlOp< BinOp >::Do | ( | ) | [inline, virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 104 of file BinaryControlOp.hxx.
References CLAM::OutControl< ControlDataType >::SendControl().
| const char * CLAM::BinaryControlOp< Multiply< TControlData > >::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 32 of file ControlMultiplier.hxx.
Member Data Documentation
| FloatInControl CLAM::BinaryControlOp< BinOp >::mFirst |
Definition at line 77 of file BinaryControlOp.hxx.
| FloatInControl CLAM::BinaryControlOp< BinOp >::mSecond |
Definition at line 78 of file BinaryControlOp.hxx.
The documentation for this class was generated from the following file:
