ATLAS Offline Software
TruthParticleValidationBaseTool.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 // TruthParticleValidationBaseTool.h
8 // Header file for class TruthParticleValidationBaseTool
9 // Author: S.Binet<binet@cern.ch>
11 #ifndef MCPARTICLETOOLS_TRUTHPARTICLEVALIDATIONBASETOOL_H
12 #define MCPARTICLETOOLS_TRUTHPARTICLEVALIDATIONBASETOOL_H 1
13 
14 // STL includes
15 #include <string>
16 
17 // FrameWork includes
18 #include "GaudiKernel/ToolHandle.h"
19 #include "GaudiKernel/ServiceHandle.h"
21 
22 // McParticleKernel includes
24 
25 // Forward declaration
26 
28  public AthAlgTool
29 {
30 
32  // Public methods:
34  public:
35 
36  // Copy constructor:
37 
39  TruthParticleValidationBaseTool( const std::string& type,
40  const std::string& name,
41  const IInterface* parent );
42 
45 
46  // Athena algorithm's Hooks
50 
52  // Protected methods:
54  protected:
55 
59 
60  // to be implemented (if needed) by derived classes
61  virtual StatusCode initializeTool();
62  virtual StatusCode finalizeTool();
63 
66  virtual StatusCode executeTool() = 0;
67 
69  // Protected data:
71  protected:
72 
75  unsigned int m_nAnalysedEvents;
76 };
77 
80 
84 
85 inline
88 {
89  return StatusCode::SUCCESS;
90 }
91 
92 inline
95 {
96  return StatusCode::SUCCESS;
97 }
98 
99 #endif //> MCPARTICLETOOLS_TRUTHPARTICLEVALIDATIONBASETOOL_H
ITruthParticleValidationTool
Definition: ITruthParticleValidationTool.h:37
TruthParticleValidationBaseTool
Definition: TruthParticleValidationBaseTool.h:29
TruthParticleValidationBaseTool::TruthParticleValidationBaseTool
TruthParticleValidationBaseTool()
Default constructor:
TruthParticleValidationBaseTool::finalizeTool
virtual StatusCode finalizeTool()
Definition: TruthParticleValidationBaseTool.h:94
TruthParticleValidationBaseTool::~TruthParticleValidationBaseTool
virtual ~TruthParticleValidationBaseTool()
Destructor:
Definition: TruthParticleValidationBaseTool.cxx:42
TruthParticleValidationBaseTool::execute
StatusCode execute()
Definition: TruthParticleValidationBaseTool.cxx:78
TruthParticleValidationBaseTool::executeTool
virtual StatusCode executeTool()=0
Main method to perform the validation.
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
AthAlgTool.h
test_pyathena.parent
parent
Definition: test_pyathena.py:15
TruthParticleValidationBaseTool::initializeTool
virtual StatusCode initializeTool()
I/O operators.
Definition: TruthParticleValidationBaseTool.h:87
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
TruthParticleValidationBaseTool::initialize
StatusCode initialize()
Athena Algorithm's Hooks.
Definition: TruthParticleValidationBaseTool.cxx:49
ITruthParticleValidationTool.h
TruthParticleValidationBaseTool::finalize
StatusCode finalize()
Definition: TruthParticleValidationBaseTool.cxx:64
AthAlgTool
Definition: AthAlgTool.h:26
TruthParticleValidationBaseTool::m_nAnalysedEvents
unsigned int m_nAnalysedEvents
Counter of analysed events.
Definition: TruthParticleValidationBaseTool.h:75