AliPhysics  2c6b7ad (2c6b7ad)
AliEmcalCorrectionEventManager Class Reference

Class to manage the current event for correction components in the EMCal correction framework. More...

#include <AliEmcalCorrectionEventManager.h>

Inheritance diagram for AliEmcalCorrectionEventManager:

Public Member Functions

 AliEmcalCorrectionEventManager ()
 
 AliEmcalCorrectionEventManager (const char *name)
 
virtual ~AliEmcalCorrectionEventManager ()
 
AliVEvent * InputEvent () const
 
bool UseEmbeddingEvent () const
 True if the embedding event should be used. More...
 
void SetInputEvent (AliVEvent *inputEvent)
 
void SetUseEmbeddingEvent (bool b=true)
 

Protected Attributes

bool fUseEmbedding
 If true, return the embedded event instead. More...
 

Private Member Functions

 AliEmcalCorrectionEventManager (const AliEmcalCorrectionEventManager &)
 
AliEmcalCorrectionEventManageroperator= (const AliEmcalCorrectionEventManager &)
 

Detailed Description

Class to manage the current event for correction components in the EMCal correction framework.

Manages the input event given to each correction component. The manager is given access to both the internal and external (embedded) event and then returns the configured event when InputEvent() is called. This allows the event manager to replace any class to AliAnalysisTaskSE::InputEvent() seamlessly.

This is particularly useful for a component which only uses (for example) embedded input objects, as it can be supplied the embedded event instead of the internal event. In such a case, the component doesn't need to know anything about the embedding framework. This also allows the integration of the PHOS tender into the EMCal Correction Framework.

Note that this class defaults to using the embedded event so that any call to a properly designed function will cause the internal event to be used. For an example of such usage, see AliEmcalCorrectionTask::AddContainersToComponent() and the corresponding calls to AliEmcalCorrectionComponent::SetUsingInputEvent(). In that case, if there is a non-embedded container, it will call SetUsingInputEvent(true), which will ensure that the component uses the internal event.

Author
Raymond Ehlers raymo.nosp@m.nd.e.nosp@m.hlers.nosp@m.@yal.nosp@m.e.edu, Yale University
Date
Jun 29, 2017

Definition at line 30 of file AliEmcalCorrectionEventManager.h.

Constructor & Destructor Documentation

AliEmcalCorrectionEventManager::AliEmcalCorrectionEventManager ( )

Standard constructor

fUseEmbedding defaults to true because our condition turns it off a standard input event is seen.

Definition at line 13 of file AliEmcalCorrectionEventManager.cxx.

AliEmcalCorrectionEventManager::AliEmcalCorrectionEventManager ( const char *  name)

Named constructor.

fUseEmbedding defaults to true because our condition turns it off a standard input event is seen.

Definition at line 26 of file AliEmcalCorrectionEventManager.cxx.

AliEmcalCorrectionEventManager::~AliEmcalCorrectionEventManager ( )
virtual

Deconstructor

Definition at line 36 of file AliEmcalCorrectionEventManager.cxx.

AliEmcalCorrectionEventManager::AliEmcalCorrectionEventManager ( const AliEmcalCorrectionEventManager )
private

Member Function Documentation

AliEmcalCorrectionEventManager& AliEmcalCorrectionEventManager::operator= ( const AliEmcalCorrectionEventManager )
private
void AliEmcalCorrectionEventManager::SetInputEvent ( AliVEvent *  inputEvent)
inline

Set the input event of the current event. This event will be returned by InputEvent() unless fUseEmbedding is true.

Parameters
inputEventInput event of the current event

Definition at line 47 of file AliEmcalCorrectionEventManager.h.

Referenced by AliEmcalCorrectionComponent::SetInputEvent().

void AliEmcalCorrectionEventManager::SetUseEmbeddingEvent ( bool  b = true)
inline

Determines whether the embedded event is returned when InputEvent() is called.

Parameters
bIf true, return the embedded event when InputEvent() is called.

Definition at line 54 of file AliEmcalCorrectionEventManager.h.

Referenced by AliEmcalCorrectionComponent::SetUsingInputEvent().

bool AliEmcalCorrectionEventManager::UseEmbeddingEvent ( ) const
inline

True if the embedding event should be used.

Definition at line 39 of file AliEmcalCorrectionEventManager.h.

Referenced by AliEmcalCorrectionComponent::Run().

Member Data Documentation

bool AliEmcalCorrectionEventManager::fUseEmbedding
protected

If true, return the embedded event instead.

Definition at line 57 of file AliEmcalCorrectionEventManager.h.

Referenced by InputEvent(), SetUseEmbeddingEvent(), and UseEmbeddingEvent().


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