CLAM::SMSAnalysis Class Reference

Class that encapsulates all the building blocks of the SegmentAnalysis example. More...

#include <SMSAnalysis.hxx>

List of all members.

Public Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
	SMSAnalysis (SMSAnalysisConfig &config)
	SMSAnalysis ()
	~SMSAnalysis ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	Supervised mode execution.
bool	Do (Frame &frame)
bool	Do (Segment &segment)
bool	ConcreteStart ()
	Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.

---

Detailed Description

Class that encapsulates all the building blocks of the SegmentAnalysis example.

Definition at line 39 of file SMSAnalysis.hxx.

---

Constructor & Destructor Documentation

CLAM::SMSAnalysis::SMSAnalysis

(

SMSAnalysisConfig &

config

)

Definition at line 38 of file SMSAnalysis.cxx.

CLAM::SMSAnalysis::SMSAnalysis

(

)

Definition at line 30 of file SMSAnalysis.cxx.

CLAM::SMSAnalysis::~SMSAnalysis

(

)

Definition at line 45 of file SMSAnalysis.cxx.

---

Member Function Documentation

bool CLAM::SMSAnalysis::ConcreteStart

(

void

)

[virtual]

Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.

When overriding this function in a class derived from ProcessingComposite be sure to call the base class (so child Processings are properly started).

Reimplemented from CLAM::ProcessingComposite.

Definition at line 78 of file SMSAnalysis.cxx.

bool CLAM::SMSAnalysis::Do

(

Segment &

segment

)

TODO: miliseconds and seconds are inconsistently used in different places?

Definition at line 138 of file SMSAnalysis.cxx.

bool CLAM::SMSAnalysis::Do

(

Frame &

frame

)

Definition at line 90 of file SMSAnalysis.cxx.

bool CLAM::SMSAnalysis::Do

(

void

)

[virtual]

Supervised mode execution.

Implements CLAM::ProcessingComposite.

Definition at line 85 of file SMSAnalysis.cxx.

const char* CLAM::SMSAnalysis::GetClassName

(

)

const [inline, virtual]

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

Reimplemented from CLAM::ProcessingComposite.

Definition at line 46 of file SMSAnalysis.hxx.

const ProcessingConfig& CLAM::SMSAnalysis::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.

Implements CLAM::ProcessingComposite.

Definition at line 52 of file SMSAnalysis.hxx.

---

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

• SMSAnalysis.hxx
• SMSAnalysis.cxx