PndProcessTask Class Reference

Task based version of a PndProcessHandler. More...

#include <PndProcessTask.h>

Inheritance diagram for PndProcessTask:

Public Member Functions
	PndProcessTask (const std::string &t_detectorName)
virtual	~PndProcessTask ()
virtual InitStatus	Init () final
	Initialise this task. This must be called AFTER SetParContainers(), otherwise we will try to pass the parameters to the PndProcesses, while the parameter were not fetched yet. More...
virtual void	Exec (Option_t *t_opt=nullptr)
	Prepare Task for processing of PndProcess (e.g. reset data arrays), process the PndProcesses and do cleanup during the PostProcessing. More...
virtual void	Finish ()
	End the task, call TearDown for all PndProcesses. More...
Public Member Functions inherited from PndPersistencyTask
	PndPersistencyTask ()
	PndPersistencyTask (const char *name, Int_t iVerbose=1)
virtual	~PndPersistencyTask ()
void	SetPersistency (Bool_t val=kTRUE)
Bool_t	GetPersistency ()
Public Member Functions inherited from PndProcessHandler
	PndProcessHandler (const std::string &t_detectorname="")
virtual	~PndProcessHandler ()
void	AddProcess (PndProcess *)
	Add a PndProcess of appropriate type to the list of PndProcesses to be managed. More...
void	SetupProcesses ()
	Call for each PndProcess the SetupParameter. More...
const std::vector< PndProcess * > &	GetProcesses ()
PndParameterRegister *	GetParameterRegister ()
const PndParameterRegister *	GetParameterRegister () const
const std::string &	GetDetectorName () const
virtual void	GetRequiredDataContainerInfo ()
virtual void	PassDataContainersToProcesses ()

Protected Member Functions
void	SetParContainers () final
	Fetch the FairRuntimeDb and populate the PndParameterRegister with all requested parameter. Has to be called before Init() More...
virtual void	PreProcessing (Option_t *)
	Do some task preparation before PndProcesses are run once per event. More...
virtual void	PostProcessing (Option_t *)
	Do some task post clean up after PndProcesses are run once per event. More...
virtual void	SetupDataArrays ()=0
	Define which data containers need to be fetched from the FairRootManager, pass the data container addresses into a simple struct to distribute the addresses to the PndProcesses so they can read and write the data to them. Needs to be implemented in the derived PndProcessTask, such as the BSEmcClusteringTask. More...
template<class T >
Bool_t	DispatchRequest (const PndContainerRegister::PndContainerType_t &t_container, PndContainerRegister *t_register, const TString &t_defaultName)
TClonesArray *	GetInputArray (const TString &t_branchname, const TString &t_classtype)
TClonesArray *	GetOutputArray (const TString &t_branchname, const TString &t_classtype, const TString &t_foldername, Bool_t t_persistenxy)
template<class T >
Bool_t	HandledRequest (const PndContainerRegister::PndContainerType_t &t_container, PndContainerRegister *t_register, const TString &t_defaultName)
Protected Member Functions inherited from PndProcessHandler
virtual void	SetupProcess (PndProcess *t_process)

Additional Inherited Members
Protected Attributes inherited from PndProcessHandler
std::vector< PndProcess * >	fProcesses {}
std::unique_ptr< PndParameterRegister >	fParameterRegister {new PndParameterRegister}
std::unique_ptr< PndContainerRegister >	fContainerRegister {new PndContainerRegister}
std::string	fDetectorName {""}

Detailed Description

Task based version of a PndProcessHandler.

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 42 of file PndProcessTask.h.

Constructor & Destructor Documentation

PndProcessTask()

PndProcessTask::PndProcessTask

(

const std::string &

t_detectorName

)

~PndProcessTask()

virtual PndProcessTask::~PndProcessTask ( )

virtual

Member Function Documentation

DispatchRequest()

template<class T >

Bool_t PndProcessTask::DispatchRequest ( const PndContainerRegister::PndContainerType_t &  t_container, PndContainerRegister *  t_register, const TString &  t_defaultName  )

inlineprotected

Definition at line 93 of file PndProcessTask.h.

References PndContainerRegister::PndContainerType_t::fClassType, and PndProcessHandler::fDetectorName.

  {
    if (t_container.fClassType == T().ClassName()) {
      if (!HandledRequest<T>(t_container, t_register, t_defaultName)) {
        LOG(error) << "PndProcessTask::DispatchRequest(): " << this->fDetectorName << " - No " << t_container.fClassType << " branch found. Aborting.";
        throw std::exception(); // Exception is catched in PndProcessTask::Init(), which will return kERROR InitStatus
      }
      return true;
    }
    return false;
  }

Exec()

virtual void PndProcessTask::Exec ( Option_t *  t_opt = nullptr )

virtual

Prepare Task for processing of PndProcess (e.g. reset data arrays), process the PndProcesses and do cleanup during the PostProcessing.

Reimplemented in TestPndProcessTask.

Finish()

virtual void PndProcessTask::Finish ( )

virtual

End the task, call TearDown for all PndProcesses.

GetInputArray()

TClonesArray* PndProcessTask::GetInputArray ( const TString &  t_branchname, const TString &  t_classtype  )

inlineprotected

Definition at line 105 of file PndProcessTask.h.

Referenced by HandledRequest().

  {
    TClonesArray *tca{nullptr};
    FairRootManager *ioman = FairRootManager::Instance();
    if (ioman == nullptr) {
      throw std::runtime_error("FairRootManager::Instance() returned nullptr");
    } else {
      tca = dynamic_cast<TClonesArray *>(ioman->GetObject(t_branchname));
      if (tca == nullptr) {
        LOG(error) << "PndTCAConstContainer<" << t_classtype << ">::Init(" << t_branchname << "): No " << t_classtype << " array with name " << t_branchname << " found!";
        return tca;
      }
    }
    return tca;
  }

GetOutputArray()

TClonesArray* PndProcessTask::GetOutputArray ( const TString &  t_branchname, const TString &  t_classtype, const TString &  t_foldername, Bool_t  t_persistenxy  )

inlineprotected

Definition at line 121 of file PndProcessTask.h.

Referenced by HandledRequest().

  {
    TClonesArray *tca{nullptr};
    FairRootManager *ioman = FairRootManager::Instance();
    if (ioman == nullptr) {
      throw std::runtime_error("FairRootManager::Instance() returned nullptr");
    } else {
      if (ioman->CheckBranch(t_branchname) == 0) {
        LOG(debug) << "Attempting to register " << t_branchname << " as a container for " << t_classtype << " in folder " << t_foldername;
        tca = ioman->Register(t_branchname, t_classtype, t_foldername, t_persistenxy);
      } else {
        tca = dynamic_cast<TClonesArray *>(ioman->GetObject(t_branchname));
        if (tca == nullptr) {
          LOG(error) << "PndTCAMutableContainer<" << t_classtype << ">::Init(" << t_branchname << "): No " << t_classtype << " array with name " << t_branchname
                     << " already exists but could not be fetched!";

          return tca;
        }
        LOG(debug) << "Found a branch already called " << t_branchname << ". Using this for container for " << t_classtype << " in folder " << t_foldername;
      }
    }
    return tca;
  }

HandledRequest()

template<class T >

Bool_t PndProcessTask::HandledRequest ( const PndContainerRegister::PndContainerType_t &  t_container, PndContainerRegister *  t_register, const TString &  t_defaultName  )

inlineprotected

Definition at line 146 of file PndProcessTask.h.

References PndContainerRegister::PndContainerType_t::fBranchname, PndContainerRegister::PndContainerType_t::fClassType, PndProcessHandler::fDetectorName, PndContainerRegister::PndContainerType_t::fIsOutput, PndContainerRegister::PndContainerType_t::fIsPersistent, GetInputArray(), GetOutputArray(), PndContainerRegister::IsBranchSet(), PndContainerRegister::PndContainerType_t::RequestsSpecificBranch(), PndContainerBaseI::SetBranchName(), PndContainerRegister::SetInput(), PndContainerRegister::SetOutput(), PndMutableContainerI< T >::SetPersistency(), PndTCAConstContainer< T >::SetTCA(), PndTCAMutableContainer< T >::SetTCA(), and status.

  {

    TString branchname = (t_container.RequestsSpecificBranch()) ? t_container.fBranchname : t_defaultName;
    LOG(debug) << "PndProcessTask::HandledRequest " << t_container.fBranchname << "(" << branchname << ") for " << t_container.fClassType;

    if (t_register->IsBranchSet(branchname)) {
      return true;
    }
    Bool_t status = kFALSE;
    if (t_container.fIsOutput) {

      PndTCAMutableContainer<T> *output = new PndTCAMutableContainer<T>();
      output->SetPersistency(t_container.fIsPersistent);
      output->SetTCA(GetOutputArray(branchname, t_container.fClassType, "Emc" + fDetectorName, t_container.fIsPersistent));
      output->SetBranchName(branchname);

      t_register->SetOutput(branchname, output);
      LOG(debug) << "PndProcessTask::HandledRequest " << t_container.fBranchname << "(" << branchname << ") for " << t_container.fClassType << " as output container.";
      status = kTRUE;
    } else {
      PndTCAConstContainer<T> *input = new PndTCAConstContainer<T>();
      input->SetTCA(GetInputArray(branchname, t_container.fClassType));
      input->SetBranchName(branchname);

      t_register->SetInput(branchname, input);
      LOG(debug) << "PndProcessTask::HandledRequest " << t_container.fBranchname << "(" << branchname << ") for " << t_container.fClassType << " as input container.";
      status = kTRUE;
    }
    return status;
  }

Init()

virtual InitStatus PndProcessTask::Init ( )

finalvirtual

Initialise this task. This must be called AFTER SetParContainers(), otherwise we will try to pass the parameters to the PndProcesses, while the parameter were not fetched yet.

Returns

InitStatus

PostProcessing()

virtual void PndProcessTask::PostProcessing ( Option_t *  )

protectedvirtual

Do some task post clean up after PndProcesses are run once per event.

Reimplemented in BSEmcClusteringTask, BSEmcPlotTask, BSEmcDigitizerTask, and BSEmcMCDepositProducerTask.

Referenced by TestPndProcessTask::Exec().

PreProcessing()

virtual void PndProcessTask::PreProcessing ( Option_t *  )

protectedvirtual

Do some task preparation before PndProcesses are run once per event.

Reimplemented in BSEmcClusteringTask, BSEmcPlotTask, BSEmcDigitizerTask, and BSEmcMCDepositProducerTask.

Referenced by TestPndProcessTask::Exec().

SetParContainers()

void PndProcessTask::SetParContainers ( )

finalprotected

Fetch the FairRuntimeDb and populate the PndParameterRegister with all requested parameter. Has to be called before Init()

SetupDataArrays()

virtual void PndProcessTask::SetupDataArrays ( )

protectedpure virtual

Define which data containers need to be fetched from the FairRootManager, pass the data container addresses into a simple struct to distribute the addresses to the PndProcesses so they can read and write the data to them. Needs to be implemented in the derived PndProcessTask, such as the BSEmcClusteringTask.

Implemented in BSEmcClusteringTask, BSEmcPlotTask, BSEmcDigitizerTask, and BSEmcMCDepositProducerTask.

---

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

• PndProcessTask.h