CLAM::ControlTraceReader Class Reference

#include <ControlTrace.hxx>

List of all members.

Public Member Functions

 ControlTraceReader ()
 ControlTraceReader (const ProcessingConfig &cfg)
virtual ~ControlTraceReader ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do ()
 Supervised mode execution method (using ports).

Protected Member Functions

bool ConcreteConfigure (const ProcessingConfig &cfgObject)
 Configuration method interface.
bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
void RemoveOldControls ()

Protected Attributes

ControlTraceReaderConfig mConfig
ControlTraceData mTrace
ControlTraceData::EventList::iterator mIterator
unsigned int mRepeatCounter
OutControlArray mOutputs

Detailed Description

Definition at line 116 of file ControlTrace.hxx.


Constructor & Destructor Documentation

CLAM::ControlTraceReader::ControlTraceReader (  ) 

Definition at line 258 of file ControlTrace.cxx.

CLAM::ControlTraceReader::ControlTraceReader ( const ProcessingConfig cfg  ) 

Definition at line 263 of file ControlTrace.cxx.

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

Definition at line 268 of file ControlTrace.cxx.

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


Member Function Documentation

bool CLAM::ControlTraceReader::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 273 of file ControlTrace.cxx.

References CLAM::Processing::Configure().

bool CLAM::ControlTraceReader::ConcreteStart ( void   )  [protected, virtual]

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

ie: adquiring resources.

Returns:
Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 309 of file ControlTrace.cxx.

References CLAM::Processing::AddConfigErrorMessage().

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

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 316 of file ControlTrace.cxx.

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

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

Implements CLAM::Processing.

Definition at line 123 of file ControlTrace.hxx.

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

References mConfig.

void CLAM::ControlTraceReader::RemoveOldControls (  )  [protected]

Definition at line 336 of file ControlTrace.cxx.

References mIterator, and mRepeatCounter.


Member Data Documentation

Definition at line 134 of file ControlTrace.hxx.

Referenced by GetConfig(), and ~ControlTraceReader().

ControlTraceData::EventList::iterator CLAM::ControlTraceReader::mIterator [protected]

Definition at line 136 of file ControlTrace.hxx.

Referenced by RemoveOldControls().

Definition at line 138 of file ControlTrace.hxx.

Definition at line 137 of file ControlTrace.hxx.

Referenced by RemoveOldControls().

Definition at line 135 of file ControlTrace.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3