ATLAS Offline Software
SpclMcValidationTool.h
Go to the documentation of this file.
1 
3 /*
4  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
5 */
6 
7 // SpclMcValidationTool.h
8 // Header file for class SpclMcValidationTool
9 // Author: S.Binet<binet@cern.ch>
11 #ifndef MCPARTICLETOOLS_SPCLMCVALIDATIONTOOL_H
12 #define MCPARTICLETOOLS_SPCLMCVALIDATIONTOOL_H
13 
14 // STL includes
15 #include <string>
16 
17 // FrameWork includes
18 
19 // McParticleTools includes
21 
22 // Forward declaration
23 class IIOMcAodTool;
24 class McEventCollection;
26 
28 {
29 
31  // Public methods:
33  public:
34 
35  // Copy constructor:
36 
38  SpclMcValidationTool( const std::string& type,
39  const std::string& name,
40  const IInterface* parent );
41 
43  virtual ~SpclMcValidationTool();
44 
46  // Const methods:
48 
50  // Non-const methods:
52 
54  // Protected methods:
56  protected:
57 
61 
62  // to be implemented (if needed) by derived classes
63  virtual StatusCode initializeTool();
64  virtual StatusCode finalizeTool();
65 
69  virtual StatusCode executeTool();
70 
74  virtual StatusCode executeTool( const McEventCollection* refMcEvents,
75  const TruthParticleContainer* mcParts );
76 
81 
83  // Protected data:
85  protected:
86 
89  StringProperty m_mcEventsName;
90 
93  StringProperty m_truthParticlesName;
94 
95  typedef ToolHandle<IIOMcAodTool> McAodTool_t;
96 
100 
101 };
102 
105 
109 
110 #endif //> MCPARTICLETOOLS_SPCLMCVALIDATIONTOOL_H
SpclMcValidationTool
Definition: SpclMcValidationTool.h:28
SpclMcValidationTool::~SpclMcValidationTool
virtual ~SpclMcValidationTool()
Destructor:
Definition: SpclMcValidationTool.cxx:55
SpclMcValidationTool::executeTool
virtual StatusCode executeTool()
Main method to perform the validation.
Definition: SpclMcValidationTool.cxx:82
TruthParticleValidationBaseTool
Definition: TruthParticleValidationBaseTool.h:29
SpclMcValidationTool::m_mcAodWriterTool
McAodTool_t m_mcAodWriterTool
Tool to write the TruthParticleContainer into a dedicated file.
Definition: SpclMcValidationTool.h:99
TruthParticleContainer
Definition: PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticleContainer.h:42
SpclMcValidationTool::setupMcAodWriterTool
StatusCode setupMcAodWriterTool()
Request pointers to the IIOMcAodTool to be able to write out TruthParticleContainer for further compa...
Definition: SpclMcValidationTool.cxx:175
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
TruthParticleValidationBaseTool.h
test_pyathena.parent
parent
Definition: test_pyathena.py:15
McEventCollection
This defines the McEventCollection, which is really just an ObjectVector of McEvent objects.
Definition: McEventCollection.h:33
SpclMcValidationTool::finalizeTool
virtual StatusCode finalizeTool()
Definition: SpclMcValidationTool.cxx:76
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
SpclMcValidationTool::m_mcEventsName
StringProperty m_mcEventsName
Location of the reference McEventCollection.
Definition: SpclMcValidationTool.h:89
SpclMcValidationTool::initializeTool
virtual StatusCode initializeTool()
Non-const methods:
Definition: SpclMcValidationTool.cxx:64
IIOMcAodTool
Definition: IIOMcAodTool.h:25
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
SpclMcValidationTool::McAodTool_t
ToolHandle< IIOMcAodTool > McAodTool_t
Definition: SpclMcValidationTool.h:95
SpclMcValidationTool::m_truthParticlesName
StringProperty m_truthParticlesName
Location of the 'to-be-validated' TruthParticleContainer.
Definition: SpclMcValidationTool.h:93
SpclMcValidationTool::SpclMcValidationTool
SpclMcValidationTool()
Default constructor: