EventInfoAttListTool Class Reference

#include <EventInfoAttListTool.h>

Inheritance diagram for EventInfoAttListTool:

Collaboration diagram for EventInfoAttListTool:

Public Member Functions
virtual StatusCode	initialize () override
	Overriding initialize, finalize and execute.
virtual StatusCode	finalize () override
	finalize - called once at the end
bool	isValid () const
const coral::AttributeListSpecification &	getAttributeSpecification () const
std::unique_ptr< AthenaAttributeList >	getAttributeListPtr (const xAOD::EventInfo &einfo) const
	AthAlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
StatusCode	eventTag (AthenaAttributeList &eventTagCol, const xAOD::EventInfo &eventInfo) const
	the various components to build their own fragments of tag
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.

Protected Attributes
coral::AttributeListSpecification *	m_attribListSpec {}

Private Types
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
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 24 of file EventInfoAttListTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

AthAlgTool()

AthAlgTool::AthAlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Constructor.

Definition at line 31 of file AthAlgTool.cxx.

                                       : 
  AthCommonDataStore<AthCommonMsg<AlgTool>> ( type, name, parent )
{
}

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.

{ return m_detStore; }

eventTag()

StatusCode EventInfoAttListTool::eventTag ( AthenaAttributeList & eventTagCol, const xAOD::EventInfo & eventInfo ) const

protected

the various components to build their own fragments of tag

build the tag associate to the event information

Event Type

Definition at line 65 of file EventInfoAttListTool.cxx.

{
  // Note: for any attribute added here, please confirm the corresponding EventInfo member being
  // retained in DAOD smart slimming:
  // PhysicsAnalysis/DerivationFramework/DerivationFrameworkCore/python/EventInfoContent.py

  bool isSimulation  = eventInfo.eventType(xAOD::EventInfo::IS_SIMULATION);
  bool isTestBeam    = eventInfo.eventType(xAOD::EventInfo::IS_TESTBEAM);
  bool isCalibration = eventInfo.eventType(xAOD::EventInfo::IS_CALIBRATION);
  eventTag["IsSimulation"] .data<bool>() = isSimulation;
  eventTag["IsCalibration"].data<bool>() = isCalibration;
  eventTag["IsTestBeam"]   .data<bool>() = isTestBeam;
 
  // run number and Event number 
  unsigned int       runNumber     = eventInfo.runNumber();
  unsigned int       condRunNumber = runNumber;
  unsigned long long eventNumber   = eventInfo.eventNumber();
  unsigned int       lumiBlock     = eventInfo.lumiBlock();
  unsigned int       mcChannel = 0;
  if (isSimulation)  mcChannel = eventInfo.mcChannelNumber();
  eventTag["McChannel"]    .data<unsigned int>()       = mcChannel;
  eventTag["RunNumber"]    .data<unsigned int>()       = runNumber;
  eventTag["EventNumber"]  .data<unsigned long long>() = eventNumber;
  eventTag["LumiBlockN"]   .data<unsigned int>()       = lumiBlock;
  eventTag["ConditionsRun"].data<unsigned int>()       = condRunNumber;
 
  unsigned long timeStamp   = eventInfo.timeStamp();
  unsigned long timeStampNS = eventInfo.timeStampNSOffset();
  unsigned long bunchId     = eventInfo.bcid();
  eventTag["EventTime"]       .data<unsigned int>() = timeStamp;
  eventTag["EventTimeNanoSec"].data<unsigned int>() = timeStampNS;
  eventTag["BunchId"]         .data<unsigned int>() = bunchId;
 
  // event weight 
  // used for event weighting in monte carlo or just an event count in data
  float evweight = 1;
  if (isSimulation) evweight = eventInfo.mcEventWeight();
  eventTag["EventWeight"].data<float>() = evweight;
 
  return StatusCode::SUCCESS;
 
}

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.

{ return m_evtStore; }

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

finalize()

StatusCode EventInfoAttListTool::finalize ( )

overridevirtual

finalize - called once at the end

Definition at line 112 of file EventInfoAttListTool.cxx.

                                           {
  ATH_MSG_DEBUG("in finalize()");
  m_attribListSpec->release();
  m_attribListSpec = nullptr;
  return AthAlgTool::finalize();
}

getAttributeListPtr()

std::unique_ptr< AthenaAttributeList > EventInfoAttListTool::getAttributeListPtr

(

const xAOD::EventInfo &

einfo

)

const

Definition at line 47 of file EventInfoAttListTool.cxx.

{
  // Create attributeList with appropriate attributes
  const coral::AttributeListSpecification& specRef = *m_attribListSpec;
  auto eventTag = std::make_unique<AthenaAttributeList> ( specRef );
 
  StatusCode sc = this->eventTag (*eventTag, eventInfo);
  if (sc.isFailure()) {
    ATH_MSG_WARNING("Unable to build Tag Fragments for the Event");
  }
 
  ATH_MSG_DEBUG("EventInfoAttListTool - getAttributeList() return success");
 
  return eventTag;
}

getAttributeSpecification()

const coral::AttributeListSpecification & EventInfoAttListTool::getAttributeSpecification

(

)

const

initialize()

StatusCode EventInfoAttListTool::initialize ( )

overridevirtual

Overriding initialize, finalize and execute.

initialization - called once at the beginning

Definition at line 22 of file EventInfoAttListTool.cxx.

                                             {
  ATH_MSG_DEBUG("in initialize()");
 
  m_attribListSpec = new coral::AttributeListSpecification();
  // Note: for any attribute added here, please confirm the corresponding EventInfo member being
  // retained in DAOD smart slimming:
  // PhysicsAnalysis/DerivationFramework/DerivationFrameworkCore/python/EventInfoContent.py
  m_attribListSpec->extend("IsSimulation",    "bool");
  m_attribListSpec->extend("IsCalibration",   "bool");
  m_attribListSpec->extend("IsTestBeam",      "bool");
  m_attribListSpec->extend("McChannel",       "unsigned int");
  m_attribListSpec->extend("RunNumber",       "unsigned int");
  m_attribListSpec->extend("EventNumber",     "unsigned long long");
  m_attribListSpec->extend("LumiBlockN",      "unsigned int");
  m_attribListSpec->extend("ConditionsRun",   "unsigned int");
  m_attribListSpec->extend("EventTime",       "unsigned int");
  m_attribListSpec->extend("EventTimeNanoSec","unsigned int");
  m_attribListSpec->extend("BunchId",         "unsigned int");
  m_attribListSpec->extend("EventWeight",     "float");
  
  return AthAlgTool::initialize();
}

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.

isValid()

bool EventInfoAttListTool::isValid

(

)

const

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()

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

overridevirtualinherited

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 in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_attribListSpec

coral::AttributeListSpecification* EventInfoAttListTool::m_attribListSpec {}

protected

Definition at line 45 of file EventInfoAttListTool.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_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:

• EventInfoAttListTool.h
• EventInfoAttListTool.cxx