CLAM::ControlSource Class Reference

#include <ControlSource.hxx>

List of all members.

Public Types
typedef ControlSourceConfig	Config
Public Member Functions
	ControlSource (const Config &c=Config())
	~ControlSource ()
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (const float value)
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
const ProcessingConfig &	GetConfig () const
	Configuration getter.

---

Detailed Description

Definition at line 52 of file ControlSource.hxx.

---

Member Typedef Documentation

typedef ControlSourceConfig CLAM::ControlSource::Config

Reimplemented from CLAM::Processing.

Definition at line 59 of file ControlSource.hxx.

---

Constructor & Destructor Documentation

CLAM::ControlSource::ControlSource

(

const Config &

c = Config()

)

[inline]

Definition at line 61 of file ControlSource.hxx.

References ConcreteConfigure().

CLAM::ControlSource::~ControlSource

(

)

Definition at line 35 of file ControlSource.cxx.

---

Member Function Documentation

bool CLAM::ControlSource::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 45 of file ControlSource.cxx.

Referenced by ControlSource().

bool CLAM::ControlSource::Do

(

const float

value

)

Definition at line 39 of file ControlSource.cxx.

bool CLAM::ControlSource::Do

(

)

[inline, virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 68 of file ControlSource.hxx.

Referenced by CLAM::NetworkPlayer::ReadControlSource().

const char* CLAM::ControlSource::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 75 of file ControlSource.hxx.

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

---

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

• ControlSource.hxx
• ControlSource.cxx