PndTCAOutputContainer implementation of PndOutputContainerI<T> for FairRootManager and TClonesArray. More...

#include <PndTCAOutputContainer.h>

Inheritance diagram for PndTCAOutputContainer< T >:

Public Member Functions
	PndTCAOutputContainer (const TString &t_foldername="", Bool_t t_persistency=kTRUE)
	Construct a new PndTCAOutputContainer object. More...

virtual	~PndTCAOutputContainer ()
	Destroy the PndTCAOutput Container object. More...

virtual Bool_t	Init (const TString &t_branchname) final
	Register the data t_branchname in form of TClonesArray * with the FairRootManager. More...

virtual void	Reset () final
	Delete all elements. More...

virtual T *	CreateCopy (const T &t_element)
	Create a copy of t_element in the TClonesArray and return a pointer to it. More...

virtual void	RemoveAt (Int_t t_index)
	remove the t_index-th element More...

virtual void	Compress ()
	Compress. More...

virtual T *	GetElement (Int_t t_idx) const final
	Get pointer to the t_idx-th element. More...

virtual ssize_t	GetSize () const final
	Get the number of elements. More...

void	SetTCA (TClonesArray *t_tca)
	Set the TClonesArray address. More...

TClonesArray *	GetTCA ()
	Get the TClonesArray address. More...

Public Member Functions inherited from PndOutputContainerI< T >
	PndOutputContainerI (const TString &t_foldername="", Bool_t t_persistency=kTRUE)
	Construct a new PndOutputContainerI object. More...

	fFolderName (t_foldername)

	fPersistency (t_persistency)

virtual	~PndOutputContainerI ()
	Destroy the PndOutputContainerI object. More...

virtual T const *	GetConstElementPtr (Int_t t_index) const
	Get the Element object at t_index. More...

std::vector< T * >	GetVector () const
	return vector of ptrs pointing at internal data, to be used to access data independent of underlying data container More...

void	SetFolderName (const TString &t_foldername)
	Set the FolderName. More...

void	SetPersistency (Bool_t t_persistency)
	Set the Persistency of the data. More...

const TString &	GetFolderName () const
	Get the Folder Name. More...

Bool_t	GetPersistency () const
	Get the Persistency of the data. More...

Public Member Functions inherited from PndContainerI< T >
	PndContainerI ()
	Construct a new PndContainerI object. More...

virtual	~PndContainerI ()
	Destroy the PndContainerI object. More...

std::vector< T const * >	GetVectorOfPtrToConst () const
	return vector of const ptrs pointing at internal data, to be used to access data independent of underlying data container More...

const TString &	GetBranchName () const
	Get the BranchName. More...

Protected Attributes
TClonesArray *	fTCA {nullptr}

Protected Attributes inherited from PndOutputContainerI< T >
TString	fFolderName {""}

Bool_t	fPersistency {kFALSE}

Protected Attributes inherited from PndContainerI< T >
TString	fBranchName {""}

Detailed Description

template<class T>
class PndTCAOutputContainer< T >

PndTCAOutputContainer implementation of PndOutputContainerI<T> for FairRootManager and TClonesArray.

Output data registered with FairRootManager as (TClonesArray *)

Template Parameters

T

Definition at line 36 of file PndTCAOutputContainer.h.

Constructor & Destructor Documentation

◆ PndTCAOutputContainer()

template<class T>

PndTCAOutputContainer< T >::PndTCAOutputContainer	(	const TString &	t_foldername = `""`,
		Bool_t	t_persistency = `kTRUE`
	)

inline

Construct a new PndTCAOutputContainer object.

Parameters

const	TString &t_foldername = ""
Bool_t	t_persistency = kTRUE

Definition at line 44 of file PndTCAOutputContainer.h.

44 : PndOutputContainerI<T>(t_foldername, t_persistency) {}

PndOutputContainerI

Definition: BSEmcAddLinksToCluster.h:28

◆ ~PndTCAOutputContainer()

template<class T>

virtual PndTCAOutputContainer< T >::~PndTCAOutputContainer ( )

inlinevirtual

Destroy the PndTCAOutput Container object.

Definition at line 50 of file PndTCAOutputContainer.h.

50 {}

Member Function Documentation

◆ Compress()

template<class T>

virtual void PndTCAOutputContainer< T >::Compress ( )

inlinevirtual

Compress.

Reimplemented from PndOutputContainerI< T >.

Definition at line 128 of file PndTCAOutputContainer.h.

   {
     if (this->fTCA != nullptr) {
       this->fTCA->Compress();
     }
   }

◆ CreateCopy()

template<class T>

virtual T* PndTCAOutputContainer< T >::CreateCopy ( const T & t_element )

inlinevirtual

Create a copy of t_element in the TClonesArray and return a pointer to it.

Parameters

const T &t_element

Returns: T*

Implements PndOutputContainerI< T >.

Definition at line 101 of file PndTCAOutputContainer.h.

Referenced by TestOutWithTCATask::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec().

   {
     if (fTCA != nullptr) {
       new ((*fTCA)[fTCA->GetEntriesFast()]) T{t_element};
     } else {
       LOG(ERROR) << "PndTCAOutputContainer::CreateCopy() no underlying std::vector";
       return nullptr;
     }
     return GetElement(GetSize() - 1);
   }

◆ GetElement()

template<class T>

virtual T* PndTCAOutputContainer< T >::GetElement ( Int_t t_idx ) const

inlinefinalvirtual

Get pointer to the t_idx-th element.

Parameters

Int_t t_idx

Returns: T*

Implements PndOutputContainerI< T >.

Definition at line 141 of file PndTCAOutputContainer.h.

Referenced by PndTCAOutputContainer< BSEmcDigi >::CreateCopy().

   {
     if (fTCA != nullptr) {
       return static_cast<T *>(fTCA->At(t_idx));
     }
     return nullptr;
   }

◆ GetSize()

template<class T>

virtual ssize_t PndTCAOutputContainer< T >::GetSize ( ) const

inlinefinalvirtual

Get the number of elements.

Returns: ssize_t

Implements PndContainerI< T >.

Definition at line 154 of file PndTCAOutputContainer.h.

Referenced by PndTCAOutputContainer< BSEmcDigi >::CreateCopy().

   {
     if (fTCA != nullptr) {
       return fTCA->GetEntriesFast();
     }
     return 0;
   }

◆ GetTCA()

template<class T>

TClonesArray* PndTCAOutputContainer< T >::GetTCA ( )

inline

Get the TClonesArray address.

Returns: TClonesArray *

Definition at line 174 of file PndTCAOutputContainer.h.

174 { return fTCA; }

PndTCAOutputContainer::fTCA

TClonesArray * fTCA

Definition: PndTCAOutputContainer.h:177

◆ Init()

template<class T>

virtual Bool_t PndTCAOutputContainer< T >::Init ( const TString & t_branchname )

inlinefinalvirtual

Register the data t_branchname in form of TClonesArray * with the FairRootManager.

Parameters

const TString &t_branchname

Implements PndContainerI< T >.

Definition at line 57 of file PndTCAOutputContainer.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init(), and TestOutWithTCATask::Init().

   {
     this->fBranchName = t_branchname;
     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().ClassName() << " in folder " << this->fFolderName;
         this->fTCA = ioman->Register(t_branchname, T().ClassName(), this->fFolderName, this->fPersistency);
       } else {
         this->fTCA = dynamic_cast<TClonesArray *>(ioman->GetObject(t_branchname));
         if (this->fTCA == nullptr) {
           // throw std::runtime_error(
           //   ("PndTCAInputContainer<" + TString{T().ClassName()} + ">::Init(" + t_branchname + "): No " + TString{T().ClassName()} + " array with name " + t_branchname + "
           //   found!")
           //     .Data());
           LOG(error) << "PndTCAOutputContainer<" << T().ClassName() << ">::Init(" << t_branchname << "): No " << T().ClassName() << " array with name " << t_branchname
                      << " already exists but could not be fetched!";
 
           return kFALSE;
         }
         LOG(debug) << "Found a branch already called " << t_branchname << ". Using this for container for " << T().ClassName() << " in folder " << this->fFolderName;
       }
     }
     return kTRUE;
   }

◆ RemoveAt()

template<class T>

virtual void PndTCAOutputContainer< T >::RemoveAt ( Int_t t_index )

inlinevirtual

remove the t_index-th element

Parameters

Int_t t_index

Implements PndOutputContainerI< T >.

Definition at line 117 of file PndTCAOutputContainer.h.

   {
     if (this->fTCA != nullptr) {
       this->fTCA->RemoveAt(t_index);
     }
   }

◆ Reset()

template<class T>

virtual void PndTCAOutputContainer< T >::Reset ( )

inlinefinalvirtual

Delete all elements.

Implements PndOutputContainerI< T >.

Definition at line 89 of file PndTCAOutputContainer.h.

Referenced by TestOutWithTCATask::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec().

   {
     if (this->fTCA != nullptr) {
       this->fTCA->Delete();
     }
   }

◆ SetTCA()

template<class T>

void PndTCAOutputContainer< T >::SetTCA ( TClonesArray * t_tca )

inline

Set the TClonesArray address.

Parameters

TClonesArray *t_tca

Definition at line 167 of file PndTCAOutputContainer.h.

167 { fTCA = t_tca; }

PndTCAOutputContainer::fTCA

TClonesArray * fTCA

Definition: PndTCAOutputContainer.h:177

Member Data Documentation

◆ fTCA

template<class T>

TClonesArray* PndTCAOutputContainer< T >::fTCA {nullptr}

protected

Definition at line 177 of file PndTCAOutputContainer.h.

Referenced by PndTCAOutputContainer< BSEmcDigi >::Compress(), PndTCAOutputContainer< BSEmcDigi >::CreateCopy(), PndTCAOutputContainer< BSEmcDigi >::GetElement(), PndTCAOutputContainer< BSEmcDigi >::GetSize(), PndTCAOutputContainer< BSEmcDigi >::GetTCA(), PndTCAOutputContainer< BSEmcDigi >::Init(), PndTCAOutputContainer< BSEmcDigi >::RemoveAt(), PndTCAOutputContainer< BSEmcDigi >::Reset(), and PndTCAOutputContainer< BSEmcDigi >::SetTCA().

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

PndTCAOutputContainer.h

Public Member Functions

Protected Attributes

Detailed Description

template<class T> class PndTCAOutputContainer< T >

Constructor & Destructor Documentation

◆ PndTCAOutputContainer()

◆ ~PndTCAOutputContainer()

Member Function Documentation

◆ Compress()

◆ CreateCopy()

◆ GetElement()

◆ GetSize()

◆ GetTCA()

◆ Init()

◆ RemoveAt()

◆ Reset()

◆ SetTCA()

Member Data Documentation

◆ fTCA

template<class T>
class PndTCAOutputContainer< T >