AthFilterAlgorithm.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/
 
// AthFilterAlgorithm.h 
// Header file for class AthFilterAlgorithm
// Author: S.Binet<binet@cern.ch>
#ifndef ATHENABASECOMPS_ATHFILTERALGORITHM_H
#define ATHENABASECOMPS_ATHFILTERALGORITHM_H 1
 
// STL includes
#include <string>
 
// Framework includes
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaKernel/ICutFlowSvc.h"
#include "AthenaBaseComps/AthAlgorithm.h"
#include "xAODEventInfo/EventInfo.h"
#include "StoreGate/ReadHandleKey.h"
 
class AthFilterAlgorithm
  : public ::AthAlgorithm
{ 
 
  // Public methods: 
 public: 
 
  // Copy constructor: 
 
  AthFilterAlgorithm( const std::string& name, ISvcLocator* pSvcLocator );
 
  virtual ~AthFilterAlgorithm(); 
 
  // Assignment operator: 
  //AthFilterAlgorithm &operator=(const AthFilterAlgorithm &alg); 
 
  // Non-const methods: 
 
  virtual StatusCode sysInitialize() override;
  
  virtual void setFilterPassed( bool state ) const;
 
  void setFilterDescription(const std::string& descr);
 
  ServiceHandle<ICutFlowSvc>& cutFlowSvc();
 
  CutIdentifier cutID();
 
  const SG::ReadHandleKey<xAOD::EventInfo>& eventInfoKey() const;
 
 
  // Private data: 
 private: 
 
  AthFilterAlgorithm();
 
  CutIdentifier m_cutID;
 
  typedef ServiceHandle<ICutFlowSvc> ICutFlowSvc_t;
  ICutFlowSvc_t m_cutFlowSvc;
 
  std::string m_filterDescr;
 
  //special case: post-python default value of property FilterDescription sent to ICutFlowSvc only if not explicitly specified before
  bool m_resetSelfDescription;
  void doNotResetSelfDescription( Gaudi::Details::PropertyBase& );
 
  SG::ReadHandleKey<xAOD::EventInfo> m_eventInfoKey
  { this, "EventInfoKey", "EventInfo", "" };
}; 
 
// Inline methods: 
 
inline
ServiceHandle<ICutFlowSvc>& 
AthFilterAlgorithm::cutFlowSvc()
{
  return m_cutFlowSvc;
}
 
 
inline
CutIdentifier AthFilterAlgorithm::cutID()
{
  return m_cutID;
}
 
 
inline 
void 
AthFilterAlgorithm::doNotResetSelfDescription( Gaudi::Details::PropertyBase& )
{ 
  m_resetSelfDescription=false; 
}
 
#endif //> !ATHENABASECOMPS_ATHFILTERALGORITHM_H