CLAM::ControlSelector Class Reference

#include <ControlSelector.hxx>

List of all members.

Public Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
	ControlSelector ()
	ControlSelector (const ControlSelectorConfig &cfg)
	~ControlSelector ()
bool	ConcreteConfigure (const ProcessingConfig &cfg)
	Configuration method interface.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do ()
	Supervised mode execution method (using ports)
void	InControlCallback (unsigned controlId, const TControlData &value)
Protected Member Functions
void	RemoveOldControls ()
void	CreateInControls (unsigned numberOfControls)

---

Detailed Description

Definition at line 45 of file ControlSelector.hxx.

---

Constructor & Destructor Documentation

CLAM::ControlSelector::ControlSelector

(

)

Definition at line 28 of file ControlSelector.cxx.

References CLAM::Processing::Configure().

CLAM::ControlSelector::ControlSelector

(

const ControlSelectorConfig &

cfg

)

Definition at line 35 of file ControlSelector.cxx.

References CLAM::Processing::Configure().

CLAM::ControlSelector::~ControlSelector

(

)

Definition at line 41 of file ControlSelector.cxx.

References RemoveOldControls().

---

Member Function Documentation

bool CLAM::ControlSelector::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 46 of file ControlSelector.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CreateInControls(), CLAM::InControl< ControlDataType >::DoControl(), RemoveOldControls(), and CLAM::DynamicType::UpdateData().

void CLAM::ControlSelector::CreateInControls

(

unsigned

numberOfControls

)

[protected]

Definition at line 66 of file ControlSelector.cxx.

References InControlCallback().

Referenced by ConcreteConfigure().

bool CLAM::ControlSelector::Do

(

)

[virtual]

Supervised mode execution method (using ports)

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 101 of file ControlSelector.cxx.

const char* CLAM::ControlSelector::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 53 of file ControlSelector.hxx.

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

void CLAM::ControlSelector::InControlCallback	(	unsigned	controlId,
		const TControlData &	value
	)

Definition at line 86 of file ControlSelector.cxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Processing::IsConfigured(), and CLAM::OutControl< ControlDataType >::SendControl().

Referenced by CreateInControls().

void CLAM::ControlSelector::RemoveOldControls

(

)

[protected]

Definition at line 77 of file ControlSelector.cxx.

Referenced by ConcreteConfigure(), and ~ControlSelector().

---

The documentation for this class was generated from the following files:

• ControlSelector.hxx
• ControlSelector.cxx