CLAM::SMSTransformationChain Class Reference

Using Segment as the type for * input and output ports. More...

#include <SMSTransformationChain.hxx>

Public Member Functions
void	AttachIn (Segment &data)
void	AttachOut (Segment &data)
	SMSTransformationChain ()
virtual	~SMSTransformationChain ()
	Destructor.
virtual bool	DoChildren ()
bool	Do ()
	Supervised mode execution method (using ports).
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.
void	InitSegmentArray ()
void	InitAllFrameIndex ()
void	TurnOn (TIndex index)
	Accessor to On/off control.
void	TurnOff (TIndex index)
	Accessor to On/off control.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
SegmentTransformation *	GetTransformation (const std::string &name)
	Returns first transformation in chain belonging to a given class or NULL if not found.

Detailed Description

Using Segment as the type for * input and output ports.

It implements the supervised Do and a helper method for updating the frame counter in the Segment.

Definition at line 34 of file SMSTransformationChain.hxx.

Constructor & Destructor Documentation

CLAM::SMSTransformationChain::SMSTransformationChain ( ) [inline]

Definition at line 45 of file SMSTransformationChain.hxx.

virtual CLAM::SMSTransformationChain::~SMSTransformationChain ( ) [inline, virtual]

Destructor.

Deletes temporal ProcessingData and Configuration and any previously allocated Processing chainee.

Definition at line 54 of file SMSTransformationChain.hxx.

Member Function Documentation

void CLAM::SMSTransformationChain::AttachIn ( Segment & data ) [inline]

Definition at line 42 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::AttachOut ( Segment & data ) [inline]

Definition at line 43 of file SMSTransformationChain.hxx.

bool CLAM::SMSTransformationChain::ConcreteConfigure ( const ProcessingConfig & ) [inline, 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.

First we remove existing chainee if any

Implements CLAM::ProcessingComposite.

Definition at line 177 of file SMSTransformationChain.hxx.

bool CLAM::SMSTransformationChain::ConcreteStart ( void ) [inline, 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 102 of file SMSTransformationChain.hxx.

bool CLAM::SMSTransformationChain::Do ( ) [inline, virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 91 of file SMSTransformationChain.hxx.

virtual bool CLAM::SMSTransformationChain::DoChildren ( ) [inline, virtual]

Definition at line 66 of file SMSTransformationChain.hxx.

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

SegmentTransformation* CLAM::SMSTransformationChain::GetTransformation ( const std::string & name ) [inline]

Returns first transformation in chain belonging to a given class or NULL if not found.

Definition at line 216 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::InitAllFrameIndex ( ) [inline]

Definition at line 153 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::InitSegmentArray ( ) [inline]

Definition at line 145 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::TurnOff ( TIndex index ) [inline]

Accessor to On/off control.

Turns on the specified control in the array.