TFWLiteSelector< TWorker > Class Template Reference

#include <FWCore/TFWLiteSelector/interface/TFWLiteSelector.h>

Inheritance diagram for TFWLiteSelector< TWorker >:

Public Member Functions
	TFWLiteSelector ()
	~TFWLiteSelector () override
Public Member Functions inherited from TFWLiteSelectorBasic
virtual void	begin (TList *&in)=0
virtual void	terminate (TList &out)=0
	TFWLiteSelectorBasic ()
	~TFWLiteSelectorBasic () override

Private Member Functions
const TFWLiteSelector &	operator= (const TFWLiteSelector &)
void	postProcessing (TList &out) override
void	preProcessing (const TList *in, TList &out) override
void	process (const edm::Event &iEvent) override
	TFWLiteSelector (const TFWLiteSelector &)

Private Attributes
edm::propagate_const< std::shared_ptr< TWorker > >	worker_

Detailed Description

template<class TWorker>
class TFWLiteSelector< TWorker >

Description: A 'safe' form of a TSelector which uses a Worker helper class to do the processing

Usage: This is a safe form of a TSelector which separates the processing (which could happen on many computers when using PROOF) from the handling of the final result (which only happens on the original computer which is running the ROOT job).

The processing is handled by a worker class. This class is expected to have the following methods 1) a constructor which takes a 'const TList*' and a 'TList&' as its arguments. The 'const TList*' holds objects The 'TList&' is used to hold all the 'TObject' items (e.g. histograms) you want to access for the final result (e.g. the sum of all histograms created by the many Workers running on different computers). You should create the items in the constructor, hold onto them as member data in the Worker and 'Add' them to the TList. In addition, the 'TList&' can hold items sent to the workers from the TFWLiteSelector. 2) a method called 'process(const edm::Event&)' this is called for each Event 3) a destructor which does what ever you want to have done after all the Events have finished

You should inherit from TFWLiteSelector<...> where the template argument should be the worker you want to use. You need to implement the following methods 1) 'begin(const TList*& itemsForProcessing)' this is called before processing has started and before any workers get created. If you want to pass data to your workers, you can create a new TList and assign it to 'itemsForProcessing' and then add the objects you want passed into that list. NOTE: you are responsible for deleting the created TList and for deleting all items held by the TList. The easiest way to do this is to add a 'std::unique_ptr<TList>' member data to your Selector and then call 'SetOwner()' on the TList. 2) 'terminate(TList&)' this is called after all processing has finished. The TList& contains all the accumulated information from all the workers.

Definition at line 57 of file TFWLiteSelector.h.

Constructor & Destructor Documentation

template<class TWorker>

TFWLiteSelector< TWorker >::TFWLiteSelector ( )

inline

Definition at line 61 of file TFWLiteSelector.h.

Referenced by TFWLiteSelector< TrackAnalysisAlgorithm >::~TFWLiteSelector().

: worker_() {}

template<class TWorker>

TFWLiteSelector< TWorker >::~TFWLiteSelector ( )

inlineoverride

Definition at line 62 of file TFWLiteSelector.h.

{}

template<class TWorker>

TFWLiteSelector< TWorker >::TFWLiteSelector ( const TFWLiteSelector< TWorker > &  )

private

Member Function Documentation

template<class TWorker>

const TFWLiteSelector& TFWLiteSelector< TWorker >::operator= ( const TFWLiteSelector< TWorker > &  )

private

Referenced by TFWLiteSelector< TrackAnalysisAlgorithm >::~TFWLiteSelector().

template<class TWorker>

void TFWLiteSelector< TWorker >::postProcessing ( TList &  out )

inlineoverrideprivatevirtual

Called each time the 'slave' has seen all the events

Parameters

out	the list of objects that will be sent to 'terminate'. You can Add() additional objects to 'out' at this point as well.

Implements TFWLiteSelectorBasic.

Definition at line 81 of file TFWLiteSelector.h.

                                               {
        worker_->postProcess(out);
      }

template<class TWorker>

void TFWLiteSelector< TWorker >::preProcessing ( const TList *  in, TList &  out  )

inlineoverrideprivatevirtual

Called each time the 'slave' is about to start processing

Parameters

in	a pointer to the list of objects created in 'begin()'. The pointer can be 0
out	a list of objects that are the result of processing (e.g. histograms). You should call 'Add()' for each object you want sent to the 'terminate' method.

Implements TFWLiteSelectorBasic.

Definition at line 75 of file TFWLiteSelector.h.

                                                              {
        worker_ = std::make_shared<TWorker>(in,out);
      }

template<class TWorker>

void TFWLiteSelector< TWorker >::process ( const edm::Event &  event )

inlineoverrideprivatevirtual

Call each time the 'slave' gets a new Event

Parameters

event

a standard edm::Event which works just like it does in cmsRun

Implements TFWLiteSelectorBasic.

Definition at line 78 of file TFWLiteSelector.h.

                                                    {
        worker_->process(iEvent);
      }

Member Data Documentation

template<class TWorker>

edm::propagate_const<std::shared_ptr<TWorker> > TFWLiteSelector< TWorker >::worker_

private

Definition at line 86 of file TFWLiteSelector.h.

Referenced by TFWLiteSelector< TrackAnalysisAlgorithm >::postProcessing(), TFWLiteSelector< TrackAnalysisAlgorithm >::preProcessing(), and TFWLiteSelector< TrackAnalysisAlgorithm >::process().