TruthParticleFilterBaseTool.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// TruthParticleFilterBaseTool.h 
// Header file for class TruthParticleFilterBaseTool
// Author: S.Binet<binet@cern.ch>
#ifndef MCPARTICLETOOLS_TRUTHPARTICLEFILTERBASETOOL_H 
#define MCPARTICLETOOLS_TRUTHPARTICLEFILTERBASETOOL_H 1
 
// STL includes
#include <string>
 
#include "GeneratorObjects/McEventCollection.h"
 
// FrameWork includes
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
 
// McParticleKernel includes
#include "McParticleKernel/ITruthParticleFilterTool.h"
 
// Forward declaration
class IMcVtxFilterTool;
class ITruthIsolationTool;
 
class TruthParticleFilterBaseTool : virtual public ITruthParticleFilterTool,
                                            public AthAlgTool
{ 
 
  // Public methods: 
 public: 
 
  // Copy constructor: 
 
  TruthParticleFilterBaseTool( const std::string& type,
                   const std::string& name, 
                   const IInterface* parent );
 
  virtual ~TruthParticleFilterBaseTool(); 
 
  // Athena algorithm's Hooks
  StatusCode  initialize();
  StatusCode  execute();
  StatusCode  finalize();
 
 
  // Protected methods: 
 protected: 
 
  TruthParticleFilterBaseTool();
 
  // to be implemented (if needed) by derived classes
  virtual StatusCode  initializeTool();
  virtual StatusCode  finalizeTool();
 
  // Protected data: 
 protected: 
 
  typedef ToolHandle<IMcVtxFilterTool> McVtxFilterTool_t;
  McVtxFilterTool_t m_mcVtxFilterTool;
 
  typedef ToolHandle<ITruthIsolationTool> IsolTool_t;
  IsolTool_t m_isolationTool;
 
  // switches
  
  BooleanProperty m_doEtIsolation;
 
  // Containers
  
  SG::ReadHandleKey<McEventCollection> m_mcEventsReadHandleKey{this,"McEvents","TruthEvent","ReadHandleKey for input  McEventCollection one wants to filter"};
 
  SG::WriteHandleKey<McEventCollection> m_mcEventsOutputWriteHandleKey{this,"McEventsOutput","GEN_AOD","WriteHandleKey for the output McEventCollection which has been filtered"};
 
}; 
 
 
 
inline
StatusCode
TruthParticleFilterBaseTool::initializeTool()
{
  return StatusCode::SUCCESS;
}
 
inline
StatusCode
TruthParticleFilterBaseTool::finalizeTool()
{
  return StatusCode::SUCCESS;
}
 
#endif //> MCPARTICLETOOLS_TRUTHPARTICLEFILTERBASETOOL_H