Lima::ProcessUnitPipeline< ProcessUnit > Class Template Reference

#include <common/ProcessUnitFramework/ProcessUnitPipeline.h>

Inheritance diagram for Lima::ProcessUnitPipeline< ProcessUnit >:

Public Member Functions
	ProcessUnitPipeline ()
virtual	~ProcessUnitPipeline ()
virtual void	init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, typename ProcessUnit::Manager *manager) override
	initialize all sub processunits with parameters from configuration file.
virtual LimaStatusCode	process (AnalysisContent &analysis) const override
	Sequentially apply each processUnit on data in analysisContent.
void	setActiveProcessUnit (const std::string &processUnitId)
void	setInactiveProcessUnit (const std::string &processUnitId)
void	push_back (const std::string &unitId, typename ProcessUnit::Manager *manager)
void	push_back (std::shared_ptr< ProcessUnit > pu)

Detailed Description

template<typename ProcessUnit>
class Lima::ProcessUnitPipeline< ProcessUnit >

Author

Benoit Mathieu

Definition at line 32 of file ProcessUnitPipeline.h.

Constructor & Destructor Documentation

ProcessUnitPipeline()

template<typename ProcessUnit >

Lima::ProcessUnitPipeline< ProcessUnit >::ProcessUnitPipeline

(

)

~ProcessUnitPipeline()

template<typename ProcessUnit >

virtual Lima::ProcessUnitPipeline< ProcessUnit >::~ProcessUnitPipeline ( )

virtual

Member Function Documentation

init()

template<typename ProcessUnit >

virtual void Lima::ProcessUnitPipeline< ProcessUnit >::init ( Common::XMLConfigurationFiles::GroupConfigurationStructure &  unitConfiguration, typename ProcessUnit::Manager *  manager  )

overridevirtual

initialize all sub processunits with parameters from configuration file.

Parameters

unitConfiguration

@IN : <group> tag in xml configuration file that contains parameters to initialize the object.

Exceptions

InvalidConfiguration	when parameters are invalids.
UndefinedMethod	if method is not implemented

process()

template<typename ProcessUnit >

virtual LimaStatusCode Lima::ProcessUnitPipeline< ProcessUnit >::process ( AnalysisContent &  analysis ) const

overridevirtual

Sequentially apply each processUnit on data in analysisContent.

This method should not return any exception but UndefinedMethod

Parameters

analysis

AnalysisContent object on which to process

push_back() [1/2]

template<typename ProcessUnit >

void Lima::ProcessUnitPipeline< ProcessUnit >::push_back	(	const std::string &	unitId,
		typename ProcessUnit::Manager *	manager
	)

push_back() [2/2]

template<typename ProcessUnit >

void Lima::ProcessUnitPipeline< ProcessUnit >::push_back

(

std::shared_ptr< ProcessUnit >

pu

)

setActiveProcessUnit()

template<typename ProcessUnit >

void Lima::ProcessUnitPipeline< ProcessUnit >::setActiveProcessUnit

(

const std::string &

processUnitId

)

Deprecated:

the inactive units must be sent as an AnalysisData in the AnalysisContent to allow various inactive units in various threads

setInactiveProcessUnit()

template<typename ProcessUnit >

void Lima::ProcessUnitPipeline< ProcessUnit >::setInactiveProcessUnit

(

const std::string &

processUnitId

)

Deprecated:

the inactive units must be sent as an AnalysisData in the AnalysisContent to allow various inactive units in various threads

---

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

• lima_common/src/common/ProcessUnitFramework/ProcessUnitPipeline.h