AliEmcalContainerUtils Class Reference

#include <AliEmcalContainerUtils.h>

Public Types
enum	InputObject_t { kNoDefinedInputObject = -1, kCaloCells = 0, kCluster = 1, kTrack = 2 }
	Type of input object to be created More...

Static Public Member Functions
static std::string	DetermineUseDefaultName (InputObject_t objType, bool esdMode, bool returnObjectType=false)
static AliVEvent *	GetEvent (AliVEvent *inputEvent, bool isEmbedding=false)
template<class T >
static T *	AddContainer (const char *n, TObjArray &collection)
template<class T >
static T *	GetContainer (Int_t i, const TObjArray &collection)
template<class T >
static T *	GetContainer (const char *name, const TObjArray &collection)

Detailed Description

Definition at line 38 of file AliEmcalContainerUtils.h.

Member Enumeration Documentation

enum AliEmcalContainerUtils::InputObject_t

Type of input object to be created

Enumerator
kNoDefinedInputObject	! Not initialized type
kCaloCells	! Calo cells
kCluster	! Cluster container
kTrack	! Track container

Definition at line 44 of file AliEmcalContainerUtils.h.

Member Function Documentation

template<class T >

T * AliEmcalContainerUtils::AddContainer ( const char *  n, TObjArray &  collection  )

inlinestatic

Create new container and attach it to the passed collection. The name provided to this function must match the name of the array attached to the new container inside the input event.

Parameters

[in]	n	Name of the container and the array the container points to
[in]	collection	Collection into which the new container will be added

Returns

Pointer to the new container

Definition at line 82 of file AliEmcalContainerUtils.h.

std::string AliEmcalContainerUtils::DetermineUseDefaultName ( InputObject_t  objType, bool  esdMode, bool  returnObjectType = false  )

static

Given a container type, it returns the proper default branch name based on the "usedefault" pattern. This is useful to properly handle creating input objects such as AliEmcalContainer derived objects. If returnObjectType is true, it returns the "default" (unlikely to change) object type instead of the branch name. This is useful to properly determine the type of an object for a TClonesArray.

This function can also be very useful in places such as an AddTask(). Using it can significantly reduce code duplication!

Parameters

[in]	objType	Type of the input object
[in]	esdMode	True if running with an ESD
[in]	returnObjectType	Returns the "default" type of the object rather than the branch name

Returns

The name corresponding to the request branch name or object type.

Definition at line 29 of file AliEmcalContainerUtils.cxx.

Referenced by AliEmcalCorrectionTask::AddContainer(), AliEmcalCorrectionTask::CheckForContainerArray(), AliEmcalCopyCollection::CreateNewObjectBranch(), AliEmcalCorrectionCellCombineCollections::Initialize(), AliEmcalCopyCollection::NewBranch(), and AliEmcalCorrectionTask::SetupCellsInfo().

template<class T >

T * AliEmcalContainerUtils::GetContainer ( Int_t  i, const TObjArray &  collection  )

inlinestatic

Get \( i^{th} \) container contained in the collection

Parameters

[in]	i	Index of the container
[in]	collection	Collection which stores available containers

Returns

Container found for the given index (NULL if no container exists for that index)

Definition at line 100 of file AliEmcalContainerUtils.h.

template<class T >

T * AliEmcalContainerUtils::GetContainer ( const char *  name, const TObjArray &  collection  )

inlinestatic

Find container container in the collection according to its name

Parameters

[in]	name	Name of the container
[in]	collection	Collection which stores available containers

Returns

Container found under the given name

Definition at line 114 of file AliEmcalContainerUtils.h.

AliVEvent * AliEmcalContainerUtils::GetEvent ( AliVEvent *  inputEvent, bool  isEmbedding = false  )

static

Get the proper event based on whether embedding is enabled or not. Useful when determining from which event an input object should be retrieved. It could either be the current input event or an embedded event.

Parameters

[in]	inputEvent	The input event of the analysis. Will be returned if nothing else is requested. Usually just InputEvent().
[in]	isEmbedding	True if the event from embedding should be used.

Returns

The input event to be used

Definition at line 104 of file AliEmcalContainerUtils.cxx.

Referenced by AliEmcalCorrectionTask::CheckForContainerArray(), AliEmcalCopyCollection::CreateNewObjectBranch(), and AliEmcalCorrectionTask::SetCellsObjectInCellContainerBasedOnProperties().

---

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

• PWG/EMCAL/EMCALbase/AliEmcalContainerUtils.h
• PWG/EMCAL/EMCALbase/AliEmcalContainerUtils.cxx