#include <CfAthAlgTool.h>

Inheritance diagram for DerivationFramework::CfAthAlgTool:

Collaboration diagram for DerivationFramework::CfAthAlgTool:

Public Member Functions
	CfAthAlgTool (const std::string &t, const std::string &n, const IInterface *p)
virtual	~CfAthAlgTool ()
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual bool	addEvent (const std::string &name, double weight=1.) const
virtual bool	addToCounter (const std::string &name, uint64_t counts=1, double weight=1.) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
CutIdentifier	getCounter (const std::string &name) const
std::string	getCounterNameById (CutIdentifier id) const
CutIdentifier	getCounterIdByName (const std::string &name) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef std::map< std::string, CutIdentifier >	NameIdMap_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< ICutFlowSvc >	m_cutFlowSvc
std::string	m_ctbasename
NameIdMap_t	m_mctn
CutIdentifier	m_bid
bool	m_bidisset
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 35 of file CfAthAlgTool.h.

Member Typedef Documentation

◆ NameIdMap_t

typedef std::map<std::string, CutIdentifier> DerivationFramework::CfAthAlgTool::NameIdMap_t

private

Definition at line 72 of file CfAthAlgTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CfAthAlgTool()

DerivationFramework::CfAthAlgTool::CfAthAlgTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 67 of file CfAthAlgTool.cxx.

                                       : 
    AthAlgTool(t,n,p),
    m_cutFlowSvc("CutFlowSvc/CutFlowSvc", n),
    m_ctbasename(n),
    m_bid(0), m_bidisset(false) {
 
    ATH_MSG_DEBUG("Calling constructor with parameters");
 
    // Declare counters base name
    declareProperty("CountersBaseName", m_ctbasename);
 
    // clean-up counter base name
    std::string fstr("ToolSvc.");
    std::string::size_type ind = m_ctbasename.find(fstr);
    if (ind != std::string::npos) m_ctbasename.erase(ind, fstr.length());
 
  }

◆ ~CfAthAlgTool()

DerivationFramework::CfAthAlgTool::~CfAthAlgTool ( )

virtual

Definition at line 88 of file CfAthAlgTool.cxx.

                              {
    
    ATH_MSG_DEBUG("Calling destructor");
  }

Member Function Documentation

◆ addEvent()

bool DerivationFramework::CfAthAlgTool::addEvent	(	const std::string &	name,
		double	weight = 1. ) const

virtual

Definition at line 104 of file CfAthAlgTool.cxx.

                                                                        {
 
    CutIdentifier id = getCounter(name);
    if ( id > 0 ) {
      m_cutFlowSvc->addEvent(id, weight);
    }
    return (id > 0);
  }

◆ addToCounter()

bool DerivationFramework::CfAthAlgTool::addToCounter	(	const std::string &	name,
		uint64_t	counts = 1,
		double	weight = 1. ) const

virtual

Definition at line 115 of file CfAthAlgTool.cxx.

                                       {
 
    CutIdentifier id = getCounter(name);
    if ( id > 0 ) {
      for (uint64_t i=0; i<counts; ++i) {
        m_cutFlowSvc->addEvent(id, weight);
      }
    }
    return (id > 0);
  }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getCounter()

CutIdentifier DerivationFramework::CfAthAlgTool::getCounter ( const std::string & name ) const

protected

Definition at line 128 of file CfAthAlgTool.cxx.

                                                                    {
 
    CutIdentifier id = getCounterIdByName(name);
    if ( id < 1 ) {
      std::string fullname = m_ctbasename + "_" + name;
      if ( ! m_bidisset ) {
        throw std::runtime_error("cutFlowSvc()->registerFilter is no longer supported. code an alternative here");
    //id = cutFlowSvc()->registerFilter(fullname, "N/A");
    m_bid = id;
      } else {
        throw std::runtime_error("cutFlowSvc()->registerCut is no longer supported. code an alternative here");
    //id = cutFlowSvc()->registerCut(fullname, "N/A", m_bid);
      }
      m_mctn[name] = id;
    }
    return id;
  }

◆ getCounterIdByName()

CutIdentifier DerivationFramework::CfAthAlgTool::getCounterIdByName ( const std::string & name ) const

protected

Definition at line 161 of file CfAthAlgTool.cxx.

                                                                            {
 
    CutIdentifier id = 0;
    
    NameIdMap_t::const_iterator it = m_mctn.find(name);
    if ( it != m_mctn.end() ) {
      id = it->second;
    }
    return id;
  }

◆ getCounterNameById()

std::string DerivationFramework::CfAthAlgTool::getCounterNameById ( CutIdentifier id ) const

protected

Definition at line 147 of file CfAthAlgTool.cxx.

                                                                   {
 
    std::string res = "__NOT_FOUND__";
 
    for (NameIdMap_t::iterator it = m_mctn.begin(); it != m_mctn.end(); ++it) {
      if ( it->second == id ) {
    res = it->first;
    break;
      }
    }
    return res;
  }

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode DerivationFramework::CfAthAlgTool::sysInitialize ( )

overridevirtual

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 94 of file CfAthAlgTool.cxx.

                                         {
 
    // retrieve CutFlowSvc instance
    CHECK( m_cutFlowSvc.retrieve() );
    
    // re-direct to base class...
    return AthAlgTool::sysInitialize();
  }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_bid

CutIdentifier DerivationFramework::CfAthAlgTool::m_bid

mutableprivate

Definition at line 76 of file CfAthAlgTool.h.

◆ m_bidisset

bool DerivationFramework::CfAthAlgTool::m_bidisset

mutableprivate

Definition at line 77 of file CfAthAlgTool.h.

◆ m_ctbasename

std::string DerivationFramework::CfAthAlgTool::m_ctbasename

private

Definition at line 69 of file CfAthAlgTool.h.

◆ m_cutFlowSvc

ServiceHandle<ICutFlowSvc> DerivationFramework::CfAthAlgTool::m_cutFlowSvc

private

Definition at line 66 of file CfAthAlgTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_mctn

NameIdMap_t DerivationFramework::CfAthAlgTool::m_mctn

mutableprivate

Definition at line 73 of file CfAthAlgTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ NameIdMap_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CfAthAlgTool()

◆ ~CfAthAlgTool()

Member Function Documentation

◆ addEvent()

◆ addToCounter()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getCounter()

◆ getCounterIdByName()

◆ getCounterNameById()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bid

◆ m_bidisset

◆ m_ctbasename

◆ m_cutFlowSvc

◆ m_detStore

◆ m_evtStore

◆ m_mctn

◆ m_varHandleArraysDeclared

◆ m_vhka