CLAM::ControlTraceWriter Class Reference

#include <ControlTrace.hxx>

Inheritance diagram for CLAM::ControlTraceWriter:

Detailed Description

Definition at line 163 of file ControlTrace.hxx.


Public Member Functions
	ControlTraceWriter ()
	ControlTraceWriter (const ProcessingConfig &cfg)
virtual	~ControlTraceWriter ()
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do ()
	Supervised mode execution method (using ports).
Protected Member Functions
bool	ConcreteConfigure (const ProcessingConfig &cfgObject)
	Configuration method interface.
bool	ConcreteStop ()
	Processing objects have to redefine this method when stoping them implies some internal changes.
void	RemoveOldControls ()
Protected Attributes
ControlTraceWriterConfig	mConfig
ControlTraceData	mTrace
InControlArray	mInputs

Constructor & Destructor Documentation

CLAM::ControlTraceWriter::ControlTraceWriter ( )

Definition at line 197 of file ControlTrace.cxx.

References CLAM::Processing::Configure(), and mConfig.

CLAM::ControlTraceWriter::ControlTraceWriter ( const ProcessingConfig & cfg )

Definition at line 202 of file ControlTrace.cxx.

References CLAM::Processing::Configure().

CLAM::ControlTraceWriter::~ControlTraceWriter ( ) [virtual]

Definition at line 207 of file ControlTrace.cxx.

References RemoveOldControls().

Member Function Documentation

const char* CLAM::ControlTraceWriter::GetClassName ( ) const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 170 of file ControlTrace.hxx.

const ProcessingConfig& CLAM::ControlTraceWriter::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 171 of file ControlTrace.hxx.

References mConfig.

bool CLAM::ControlTraceWriter::Do ( ) [virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 246 of file ControlTrace.cxx.

References CLAM::ControlTraceData::Append(), mInputs, and mTrace.

bool CLAM::ControlTraceWriter::ConcreteConfigure ( const ProcessingConfig & ) [protected, 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 212 of file ControlTrace.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), mConfig, mInputs, and RemoveOldControls().

bool CLAM::ControlTraceWriter::ConcreteStop ( ) [protected, virtual]

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.