PandaRoot
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PndProcessHandler< DataStruct > Class Template Reference

Base class for classes handling a set of PndProcesses. More...

#include <PndProcessHandler.h>

Inheritance diagram for PndProcessHandler< DataStruct >:
PndProcessTask< DataStruct >

Public Member Functions

 PndProcessHandler (const std::string &t_detectorname="")
 
virtual ~PndProcessHandler ()
 
void AddProcess (PndProcess< DataStruct > *)
 Add a PndProcess of appropriate type to the list of PndProcesses to be managed. More...
 
void CallProcesses ()
 Call for all PndProcesses the PreProcess/Process/PosProcess functions. More...
 
void SetupProcesses ()
 Call for each PndProcess the SetData and SetupParameter. More...
 
const std::vector< PndProcess< DataStruct > * > & GetProcesses ()
 
const DataStruct * GetCopyOfData () const
 
DataStruct * GetPtrToData ()
 
PndParameterRegister * GetParameterRegister ()
 
const PndParameterRegister * GetParameterRegister () const
 
const std::string & GetDetectorName () const
 

Protected Member Functions

virtual void SetupProcess (PndProcess< DataStruct > *t_process)
 

Protected Attributes

std::vector< PndProcess< DataStruct > * > fProcesses {}
 
std::unique_ptr< DataStruct > fData {new DataStruct}
 
std::unique_ptr< PndParameterRegister > fParameterRegister {new PndParameterRegister}
 
std::string fDetectorName {""}
 

Detailed Description

template<class DataStruct>
class PndProcessHandler< DataStruct >

Base class for classes handling a set of PndProcesses.

Author
Ben Salisbury salis.nosp@m.bury.nosp@m.@hisk.nosp@m.p.un.nosp@m.i-bon.nosp@m.n.de, HISKP Bonn
Date
2021-02
Template Parameters
DataStruct

Definition at line 18 of file PndProcessHandler.h.

Constructor & Destructor Documentation

◆ PndProcessHandler()

template<class DataStruct>
PndProcessHandler< DataStruct >::PndProcessHandler ( const std::string &  t_detectorname = "")
inline

Definition at line 20 of file PndProcessHandler.h.

20 : fDetectorName(t_detectorname){};
PndProcessHandler::fDetectorName
std::string fDetectorName
Definition: PndProcessHandler.h:54

◆ ~PndProcessHandler()

template<class DataStruct >
PndProcessHandler< DataStruct >::~PndProcessHandler ( )
virtual

Definition at line 58 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::PndProcessHandler().

59 {
60  for (PndProcess<DataStruct> *process : this->fProcesses) {
61  delete process;
62  }
63  this->fProcesses.clear();
64 }
PndProcess
Base Process class.
Definition: PndProcess.h:24
PndProcessHandler::fProcesses
std::vector< PndProcess< DataStruct > * > fProcesses
Definition: PndProcessHandler.h:51

Member Function Documentation

◆ AddProcess()

template<class DataStruct>
void PndProcessHandler< DataStruct >::AddProcess ( PndProcess< DataStruct > *  t_process)

Add a PndProcess of appropriate type to the list of PndProcesses to be managed.

Definition at line 67 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::PndProcessHandler().

68 {
69  t_process->SetDetectorName(fDetectorName);
70  fParameterRegister->AddRequestList(t_process->GetListOfRequiredParameters());
71  this->fProcesses.push_back(t_process);
72 }
PndProcessHandler::fParameterRegister
std::unique_ptr< PndParameterRegister > fParameterRegister
Definition: PndProcessHandler.h:53
PndProcess::SetDetectorName
virtual void SetDetectorName(const std::string &t_detectorname)
Set the Detector name. Important, as most EmcParameter need to know for which detector they need to b...
Definition: PndProcess.h:35
PndProcessHandler::fDetectorName
std::string fDetectorName
Definition: PndProcessHandler.h:54
PndProcess::GetListOfRequiredParameters
const std::vector< std::string > & GetListOfRequiredParameters() const
Get the List Of Required Parameters.
Definition: PndProcess.h:42
PndProcessHandler::fProcesses
std::vector< PndProcess< DataStruct > * > fProcesses
Definition: PndProcessHandler.h:51

◆ CallProcesses()

template<class DataStruct >
void PndProcessHandler< DataStruct >::CallProcesses ( )

Call for all PndProcesses the PreProcess/Process/PosProcess functions.

Definition at line 90 of file PndProcessHandler.h.

Referenced by PndProcessTask< BSEmcPlotData >::Exec(), and PndProcessHandler< BSEmcPlotData >::PndProcessHandler().

91 {
92  for (PndProcess<DataStruct> *process : this->fProcesses) {
93  process->PreProcess();
94  process->Process();
95  process->PostProcess();
96  }
97 }
PndProcess
Base Process class.
Definition: PndProcess.h:24
PndProcessHandler::fProcesses
std::vector< PndProcess< DataStruct > * > fProcesses
Definition: PndProcessHandler.h:51

◆ GetCopyOfData()

template<class DataStruct>
const DataStruct* PndProcessHandler< DataStruct >::GetCopyOfData ( ) const
inline

Definition at line 42 of file PndProcessHandler.h.

42 { return fData.get(); }
PndProcessHandler::fData
std::unique_ptr< DataStruct > fData
Definition: PndProcessHandler.h:52

◆ GetDetectorName()

template<class DataStruct>
const std::string& PndProcessHandler< DataStruct >::GetDetectorName ( ) const
inline

Definition at line 46 of file PndProcessHandler.h.

46 { return fDetectorName; }
PndProcessHandler::fDetectorName
std::string fDetectorName
Definition: PndProcessHandler.h:54

◆ GetParameterRegister() [1/2]

template<class DataStruct>
PndParameterRegister* PndProcessHandler< DataStruct >::GetParameterRegister ( )
inline

Definition at line 44 of file PndProcessHandler.h.

44 { return fParameterRegister.get(); }
PndProcessHandler::fParameterRegister
std::unique_ptr< PndParameterRegister > fParameterRegister
Definition: PndProcessHandler.h:53

◆ GetParameterRegister() [2/2]

template<class DataStruct>
const PndParameterRegister* PndProcessHandler< DataStruct >::GetParameterRegister ( ) const
inline

Definition at line 45 of file PndProcessHandler.h.

45 { return fParameterRegister.get(); }
PndProcessHandler::fParameterRegister
std::unique_ptr< PndParameterRegister > fParameterRegister
Definition: PndProcessHandler.h:53

◆ GetProcesses()

template<class DataStruct>
const std::vector<PndProcess<DataStruct> *>& PndProcessHandler< DataStruct >::GetProcesses ( )
inline

Definition at line 41 of file PndProcessHandler.h.

41 { return fProcesses; }
PndProcessHandler::fProcesses
std::vector< PndProcess< DataStruct > * > fProcesses
Definition: PndProcessHandler.h:51

◆ GetPtrToData()

template<class DataStruct>
DataStruct* PndProcessHandler< DataStruct >::GetPtrToData ( )
inline

Definition at line 43 of file PndProcessHandler.h.

43 { return fData.get(); }
PndProcessHandler::fData
std::unique_ptr< DataStruct > fData
Definition: PndProcessHandler.h:52

◆ SetupProcess()

template<class DataStruct>
void PndProcessHandler< DataStruct >::SetupProcess ( PndProcess< DataStruct > *  t_process)
protectedvirtual

Reimplemented in BSEmcPlotTask.

Definition at line 84 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::GetDetectorName(), and PndProcessHandler< BSEmcPlotData >::SetupProcesses().

85 {
86  t_process->SetupParameters(this->fParameterRegister.get());
87 }
PndProcessHandler::fParameterRegister
std::unique_ptr< PndParameterRegister > fParameterRegister
Definition: PndProcessHandler.h:53
PndProcess::SetupParameters
virtual void SetupParameters(const PndParameterRegister *t_parameter)=0
Fetch all parameters from the PndParameterRegister.

◆ SetupProcesses()

template<class DataStruct >
void PndProcessHandler< DataStruct >::SetupProcesses ( )

Call for each PndProcess the SetData and SetupParameter.

Definition at line 75 of file PndProcessHandler.h.

Referenced by PndProcessTask< BSEmcPlotData >::Init(), and PndProcessHandler< BSEmcPlotData >::PndProcessHandler().

76 {
77  for (PndProcess<DataStruct> *process : this->fProcesses) {
78  process->SetData(fData.get());
79  this->SetupProcess(process);
80  }
81 }
PndProcess
Base Process class.
Definition: PndProcess.h:24
PndProcessHandler::fData
std::unique_ptr< DataStruct > fData
Definition: PndProcessHandler.h:52
PndProcessHandler::SetupProcess
virtual void SetupProcess(PndProcess< DataStruct > *t_process)
Definition: PndProcessHandler.h:84
PndProcessHandler::fProcesses
std::vector< PndProcess< DataStruct > * > fProcesses
Definition: PndProcessHandler.h:51

Member Data Documentation

◆ fData

template<class DataStruct>
std::unique_ptr<DataStruct> PndProcessHandler< DataStruct >::fData {new DataStruct}
protected

Definition at line 52 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::GetCopyOfData(), PndProcessHandler< BSEmcPlotData >::GetPtrToData(), and PndProcessHandler< BSEmcPlotData >::SetupProcesses().

◆ fDetectorName

template<class DataStruct>
std::string PndProcessHandler< DataStruct >::fDetectorName {""}
protected

Definition at line 54 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::AddProcess(), PndProcessTask< BSEmcPlotData >::Finish(), PndProcessHandler< BSEmcPlotData >::GetDetectorName(), PndProcessTask< BSEmcPlotData >::PostProcessing(), PndProcessTask< BSEmcPlotData >::PreProcessing(), and PndProcessTask< BSEmcPlotData >::SetParContainers().

◆ fParameterRegister

template<class DataStruct>
std::unique_ptr<PndParameterRegister> PndProcessHandler< DataStruct >::fParameterRegister {new PndParameterRegister}
protected

Definition at line 53 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::AddProcess(), PndProcessHandler< BSEmcPlotData >::GetParameterRegister(), PndProcessTask< BSEmcPlotData >::SetParContainers(), and PndProcessHandler< BSEmcPlotData >::SetupProcess().

◆ fProcesses

template<class DataStruct>
std::vector<PndProcess<DataStruct> *> PndProcessHandler< DataStruct >::fProcesses {}
protected

Definition at line 51 of file PndProcessHandler.h.

Referenced by PndProcessHandler< BSEmcPlotData >::AddProcess(), PndProcessHandler< BSEmcPlotData >::CallProcesses(), PndProcessTask< BSEmcPlotData >::Finish(), PndProcessHandler< BSEmcPlotData >::GetProcesses(), PndProcessHandler< BSEmcPlotData >::SetupProcesses(), and PndProcessHandler< BSEmcPlotData >::~PndProcessHandler().

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