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 47 of file BinaryControlOp.hxx.

Member Typedef Documentation

template<typename BinOp >

typedef BinaryControlOpConfig CLAM::BinaryControlOp< BinOp >::Config

Reimplemented from CLAM::Processing.

Definition at line 74 of file BinaryControlOp.hxx.

Constructor & Destructor Documentation

template<typename BinOp >

CLAM::BinaryControlOp< BinOp >::BinaryControlOp ( const BinaryControlOpConfig & cfg = Config() ) [inline]

Definition at line 78 of file BinaryControlOp.hxx.

References CLAM::Processing::Configure().

Member Function Documentation

template<typename BinOp >

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)

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 89 of file BinaryControlOp.hxx.

template<typename BinOp >

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 102 of file BinaryControlOp.hxx.

template<typename BinOp >

TControlData CLAM::BinaryControlOp< BinOp >::DoOperation ( ) [inline]

Definition at line 97 of file BinaryControlOp.hxx.

template<>

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.

template<typename BinOp >

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 95 of file BinaryControlOp.hxx.