Trigger configuration metadata tool for xAOD analysis. More...

#include <xAODConfigTool.h>

Inheritance diagram for TrigConf::xAODConfigTool:

Collaboration diagram for TrigConf::xAODConfigTool:

Classes
struct	Impl

Public Types
Definition of the StoreGate-like object's definition
typedef ServiceHandle< StoreGateSvc >	MetaStore_t
	Type of the metadata store object in Athena.
typedef const ServiceHandle< StoreGateSvc > &	MetaStorePtr_t
	Type of the metadata store pointer in standalone mode.

Public Member Functions
	xAODConfigTool (const std::string &name="TrigConf::xAODConfigTool")
	Create a proper constructor for Athena.
virtual	~xAODConfigTool () override
	Out-of-line dtor so that we don't need to define Impl in the header.
virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena.
virtual void	print () const
	Print the state of the tool.
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
virtual const ::TrigConf::L1Menu &	l1Menu (const ::EventContext &ctx) const =0
	Returns the JSON configured L1 ptree.
virtual const ::TrigConf::L1PrescalesSet &	l1PrescalesSet (const ::EventContext &ctx) const =0
	Returns the JSON configured L1 prescales ptree.
virtual const ::TrigConf::L1BunchGroupSet &	l1BunchGroupSet (const ::EventContext &ctx) const =0
	Returns the JSON configured bunchgroup ptree.
virtual const ::TrigConf::HLTMenu &	hltMenu (const ::EventContext &ctx) const =0
	Returns the JSON configured HLTMenu ptree.
virtual const ::TrigConf::HLTMonitoring &	hltMonitoring (const ::EventContext &ctx) const =0
	Returns the JSON configured HLTMonitoring ptree.
virtual const ::TrigConf::HLTPrescalesSet &	hltPrescalesSet (const ::EventContext &ctx) const =0
	Returns the JSON configured HLT prescales ptree.
Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize () override
	Function initialising the tool.
Implementation of the IILVL1ConfigSvc interface
virtual const CTPConfig *	ctpConfig () const override
	Get the LVL1 trigger menu.
virtual const ThresholdConfig *	thresholdConfig () const override
	Get the LVL1 threshold configuruation (not available from xAOD)
virtual const BunchGroupSet *	bunchGroupSet () const override
	Get the LVL1 bunch group set.
virtual uint32_t	lvl1PrescaleKey () const override
	Get the LVL1 prescale key.
virtual uint32_t	bunchGroupSetKey () const override
	Get the LVL1 bunch group set key.
Implementation of the IIHLTConfigSvc interface
virtual const HLTChainList &	chains () const override
	Get the HLT chains.
virtual const HLTSequenceList &	sequences () const override
	Get the HLT sequences.
virtual uint32_t	masterKey () const override
	Get the Super Master Key.
virtual uint32_t	hltPrescaleKey () const override
	Get the HLT prescale key.
Impliment the JSON config interface.
virtual const HLTMenu &	hltMenu (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured HLTMenu ptree.
virtual const HLTMonitoring &	hltMonitoring (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured HLTMonitoring ptree.
virtual const L1Menu &	l1Menu (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured L1 ptree.
virtual const HLTPrescalesSet &	hltPrescalesSet (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured HLT prescales ptree.
virtual const L1PrescalesSet &	l1PrescalesSet (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured L1 prescales ptree.
virtual const L1BunchGroupSet &	l1BunchGroupSet (const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Returns the JSON configured bunchgroup ptree.
Functions providing access to the input/output metadata
MetaStorePtr_t	inputMetaStore () const
	Accessor for the input metadata store.
MetaStorePtr_t	outputMetaStore () const
	Accessor for the output metadata store.
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
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.
Callback function(s) from AsgMetadataTool
virtual StatusCode	beginInputFile () override
	Function called when a new input file is opened.
virtual StatusCode	beginEvent () override
	Function called when a new event is loaded.
StatusCode	beginEvent_Run2 (const xAOD::TrigConfKeys *keys)
	Internal call to check / load from a file with Run2 metadata.
StatusCode	beginEvent_Run3 (const xAOD::TrigConfKeys keys, const xAOD::BunchConfKey bgKey)
	Internal call to check / load from a file with Run3 metadata.
Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)
virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent.
virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed.
virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata.

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>
Run 3 helper functions
StatusCode	loadJsonByKey (const std::string &humanName, const xAOD::TriggerMenuJsonContainer metaContainer, const uint32_t keyToCheck, const xAOD::TriggerMenuJson &ptrToSet)
	Locates a Run3 TriggerMenuJson object inside a container by key. Loads it into the m_currentXXXJson ptr.
StatusCode	loadPtrees ()
	Load all m_currentXXXJson serialised JSON data into ptrees inside m_impl.
StatusCode	loadPtree (const std::string &humanName, const xAOD::TriggerMenuJson *menu, DataStructure &dataStructure)
	Load single m_currentXXXJson serialised JSON data into ptree.

Private Attributes
std::string	m_eventName
	Key for the event-level configuration identifier object.
std::string	m_bgkeysName
	Key for the event-level bunchgroup identification object, in the codebase since R2 but only being used since R3.
std::string	m_metaName_run2
	Key for the trigger configuration metadata object (Run 2)
std::string	m_metaNameJSON_hlt
	Key for the trigger configuration metadata objects (Run 3)
std::string	m_metaNameJSON_hltmonitoring
std::string	m_metaNameJSON_l1
std::string	m_metaNameJSON_hltps
std::string	m_metaNameJSON_l1ps
std::string	m_metaNameJSON_bg
const xAOD::TriggerMenuContainer *	m_tmc
	The configuration object of the current input file (for Run2 AOD)
const xAOD::TriggerMenuJsonContainer *	m_hltJson
	The configuration object of the current input file (for Run3 AOD)
const xAOD::TriggerMenuJsonContainer *	m_hltmonitoringJson
const xAOD::TriggerMenuJsonContainer *	m_l1Json
const xAOD::TriggerMenuJsonContainer *	m_hltpsJson
const xAOD::TriggerMenuJsonContainer *	m_l1psJson
const xAOD::TriggerMenuJsonContainer *	m_bgJson
const xAOD::TriggerMenu *	m_menu
	The active configuration for the current event (For Run2 AOD)
const xAOD::TriggerMenuJson *	m_currentHltJson
	The active configuration for the current event (For Run3 AOD)
const xAOD::TriggerMenuJson *	m_currentHltmonitoringJson
const xAOD::TriggerMenuJson *	m_currentL1Json
const xAOD::TriggerMenuJson *	m_currentHltpsJson
const xAOD::TriggerMenuJson *	m_currentL1psJson
const xAOD::TriggerMenuJson *	m_currentBgJson
bool	m_triggerMenuContainerAvailable
	Is decoded R2 format data available?
bool	m_menuJSONContainerAvailable
	Is decoded R3 format data available?
std::unique_ptr< Impl >	m_impl
MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store.
MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store.
bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file.
bool	m_useIncidents
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

Trigger configuration metadata tool for xAOD analysis.

This tool is meant to be used when analysing xAOD files both in Athena and in ROOT, to get access to the trigger configuration information of the processed events.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 631651

Date: 2014-11-27 19:33:16 +0100 (Thu, 27 Nov 2014)

Definition at line 54 of file xAODConfigTool.h.

Member Typedef Documentation

◆ MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ xAODConfigTool()

TrigConf::xAODConfigTool::xAODConfigTool ( const std::string & name = "TrigConf::xAODConfigTool" )

Create a proper constructor for Athena.

Constructor for standalone usage

Definition at line 51 of file xAODConfigTool.cxx.

      : asg::AsgMetadataTool( name ),
        m_tmc( nullptr ),
        m_hltJson( nullptr), m_hltmonitoringJson(nullptr), m_l1Json( nullptr ),
        m_hltpsJson( nullptr ), m_l1psJson( nullptr ), m_bgJson( nullptr ),
        m_menu( nullptr ),
        m_currentHltJson( nullptr ), m_currentHltmonitoringJson( nullptr ), m_currentL1Json( nullptr ),
        m_currentHltpsJson( nullptr ), m_currentL1psJson( nullptr ), m_currentBgJson( nullptr ),
        m_triggerMenuContainerAvailable(false),
        m_menuJSONContainerAvailable(false),
        m_impl (std::make_unique<Impl>()) {
 
      declareProperty( "EventObjectName", m_eventName = "TrigConfKeys" );
      declareProperty( "BGKeysObjectName", m_bgkeysName = "BunchConfKey" );
      declareProperty( "MetaObjectName", m_metaName_run2 = "TriggerMenu" );
 
      declareProperty( "JSONMetaObjectNameHLT", m_metaNameJSON_hlt = "TriggerMenuJson_HLT" );
      declareProperty( "JSONMetaObjectNameHLTMonitoring", m_metaNameJSON_hltmonitoring = "TriggerMenuJson_HLTMonitoring" );
      declareProperty( "JSONMetaObjectNameL1", m_metaNameJSON_l1 = "TriggerMenuJson_L1" );
      declareProperty( "JSONMetaObjectNameHLTPS", m_metaNameJSON_hltps = "TriggerMenuJson_HLTPS" );
      declareProperty( "JSONMetaObjectNameL1PS", m_metaNameJSON_l1ps = "TriggerMenuJson_L1PS" );
      declareProperty( "JSONMetaObjectNameBunchgroup", m_metaNameJSON_bg = "TriggerMenuJson_BG" );
   }

◆ ~xAODConfigTool()

TrigConf::xAODConfigTool::~xAODConfigTool ( )

overridevirtualdefault

Out-of-line dtor so that we don't need to define Impl in the header.

Member Function Documentation

◆ beginEvent()

StatusCode TrigConf::xAODConfigTool::beginEvent ( )

overrideprotectedvirtual

Function called when a new event is loaded.

Reimplemented from asg::AsgMetadataTool.

Definition at line 420 of file xAODConfigTool.cxx.

                                         {
 
      // It may be that the input file opening event is missed in standalone
      // mode at the very beginning of the application. (Depending on the
      // creation order of the objects.) So make sure that we have the
      // configuration objects at hand...
      if( !m_triggerMenuContainerAvailable and !m_menuJSONContainerAvailable ) {
         ATH_CHECK( beginInputFile() );
      }
 
      // Read the current event's trigger keys:
      const xAOD::TrigConfKeys* keys = nullptr;
      ATH_CHECK( evtStore()->retrieve( keys, m_eventName ) );
 
      const xAOD::BunchConfKey* bgKey = nullptr; // The BG key is currently optional, only files written from late 2021 will contain this 
      if (evtStore()->contains<xAOD::BunchConfKey>(m_bgkeysName)) {
         ATH_CHECK(evtStore()->retrieve(bgKey, m_bgkeysName));
      }
 
      // Prefer Run 3 data if available
      if (m_menuJSONContainerAvailable) {
         return beginEvent_Run3(keys, bgKey);
      } else if (m_triggerMenuContainerAvailable) {
         return beginEvent_Run2(keys);
      }
 
      ATH_MSG_ERROR( "Both m_menuJSONContainerAvailable and m_triggerMenuContainerAvailable are false");
      return StatusCode::FAILURE;
 
   }

◆ beginEvent_Run2()

StatusCode TrigConf::xAODConfigTool::beginEvent_Run2 ( const xAOD::TrigConfKeys * keys )

protected

Internal call to check / load from a file with Run2 metadata.

Definition at line 451 of file xAODConfigTool.cxx.

                                                                          {
      // Check if we have the correct menu already:
      if( m_menu && xAODKeysMatch( keys, m_menu ) ) {
         return StatusCode::SUCCESS;
      }
 
      // If not, let's look for the correct configuration:
      xAOD::TriggerMenuContainer::const_iterator menu_itr = m_tmc->begin();
      xAOD::TriggerMenuContainer::const_iterator menu_end = m_tmc->end();
      for( ; menu_itr != menu_end; ++menu_itr ) {
         // Check if this is the menu we're looking for:
         if( ! xAODKeysMatch( keys, *menu_itr ) ) continue;
         // Remember it's pointer:
         m_menu = *menu_itr;
         // Cache the menu's configuration:
         ATH_CHECK( prepareTriggerMenu( m_menu, m_impl->m_ctpConfig,
                                        m_impl->m_chainList,
                                        m_impl->m_sequenceList,
                                        m_impl->m_bgSet, msg() ) );
         // We're done:
         return StatusCode::SUCCESS;
      }
 
      // Apparently we didn't find the correct menu!
      ATH_MSG_ERROR( "Couldn't find configuration for current event (SMK:"
                     << keys->smk() << ", L1PSK:" << keys->l1psk()
                     << ", HLTPSK:" << keys->hltpsk() << ")" );
      return StatusCode::FAILURE;
   }

◆ beginEvent_Run3()

StatusCode TrigConf::xAODConfigTool::beginEvent_Run3	(	const xAOD::TrigConfKeys *	keys,
		const xAOD::BunchConfKey *	bgKey )

protected

Internal call to check / load from a file with Run3 metadata.

Definition at line 481 of file xAODConfigTool.cxx.

                                                                                                         {
      if (keys==nullptr) {
         ATH_MSG_ERROR("nullptr TrigConfKeys");
         return StatusCode::FAILURE;
      }
 
      // Check if we have the correct menu already:
      bool validConfig = true;
      if (m_currentHltJson->key() != keys->smk()) {
         validConfig = false;
      }
      // m_currentHltminitoringJson is checked by the m_currentHltJson check
      if (m_currentL1Json->key() != keys->smk()) {
         validConfig = false;
      }
      if (m_currentHltpsJson->key() != keys->hltpsk()) {
         validConfig = false;
      }
      if (m_currentL1psJson->key() != keys->l1psk()) {
         validConfig = false;
      }
      if (m_bgJson && m_currentBgJson && bgKey && m_currentBgJson->key() != static_cast<unsigned int>(bgKey->id())) {
          validConfig = false;
      }
 
      if (validConfig) {
         return StatusCode::SUCCESS;
      }
 
      // If not, load correct JSON menus from their respective containers, matching against the event's keys ...
      ATH_CHECK( loadJsonByKey("HLT Menu", m_hltJson, keys->smk(), m_currentHltJson) );
      if (m_hltmonitoringJson && m_hltmonitoringJson->size()) {
         ATH_CHECK( loadJsonByKey("HLT Monitoring", m_hltmonitoringJson, keys->smk(), m_currentHltmonitoringJson) );
      }
      ATH_CHECK( loadJsonByKey("L1 Menu", m_l1Json, keys->smk(), m_currentL1Json) );
      ATH_CHECK( loadJsonByKey("HLT Prescales", m_hltpsJson, keys->hltpsk(), m_currentHltpsJson) );
      ATH_CHECK( loadJsonByKey("L1 Prescales", m_l1psJson, keys->l1psk(), m_currentL1psJson) );
      if (m_bgJson && bgKey) {
         ATH_CHECK( loadJsonByKey("Bunchgroups", m_bgJson, bgKey->id(), m_currentBgJson) );
      }
 
      // ... and from these serialised JSON strings, populate the ptree data structures...
      ATH_CHECK( loadPtrees() ); 
 
      // ... and set the keys of the objects in the objects (not part of the JSON pyaload) ...
      m_impl->m_currentHlt.setSMK( m_currentHltJson->key() );
      if (m_currentHltmonitoringJson) {
         m_impl->m_currentHltmonitoring.setSMK( m_currentHltmonitoringJson->key() );
      }
      m_impl->m_currentL1.setSMK( m_currentL1Json->key() );
      m_impl->m_currentHltps.setPSK( m_currentHltpsJson->key() );
      m_impl->m_currentL1ps.setPSK( m_currentL1psJson->key() );
      if (m_bgJson && bgKey) {
         m_impl->m_currentBg.setBGSK( m_currentBgJson->key() );
      }
 
      // R3 interfaces now active
 
      // ... and finally populate the legacy interface from the ptree data
      ATH_CHECK( prepareTriggerMenu( m_impl->m_currentHlt,
                                     m_impl->m_currentL1,
                                     m_impl->m_currentHltps,
                                     m_impl->m_currentL1ps,
                                     m_impl->m_currentBg,
                                     m_impl->m_ctpConfig,
                                     m_impl->m_chainList,
                                     m_impl->m_sequenceList,
                                     m_impl->m_bgSet, msg() ) ); // R2 interfaces now active
 
      return StatusCode::SUCCESS;
   }

◆ beginInputFile()

StatusCode TrigConf::xAODConfigTool::beginInputFile ( )

overrideprotectedvirtual

Function called when a new input file is opened.

Reimplemented from asg::AsgMetadataTool.

Definition at line 273 of file xAODConfigTool.cxx.

                                             {
 
      // Tell the user what's happening:
      ATH_MSG_DEBUG( "Loading the trigger menu from a new input file" );
 
      // Try to read the R2 metadata object:
      m_tmc = nullptr;
      m_triggerMenuContainerAvailable = true;
      if( !inputMetaStore()->contains<xAOD::TriggerMenuContainer>(m_metaName_run2)
          or inputMetaStore()->retrieve( m_tmc, m_metaName_run2 ).isFailure() )
      {
         m_triggerMenuContainerAvailable = false;
      }
 
      // Try to read the R3 metadata object:
      m_hltJson = nullptr;
      m_hltmonitoringJson = nullptr;
      m_l1Json = nullptr;
      m_hltpsJson = nullptr;
      m_l1psJson = nullptr;
      m_bgJson = nullptr;
      m_menuJSONContainerAvailable = true;
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_hlt)
          or inputMetaStore()->retrieve( m_hltJson, m_metaNameJSON_hlt ).isFailure() )
      {
         m_menuJSONContainerAvailable = false;
      }
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_hltmonitoring)
          or inputMetaStore()->retrieve( m_hltmonitoringJson, m_metaNameJSON_hltmonitoring ).isFailure() )
      {
         // m_menuJSONContainerAvailable = false;
         // Currently planning on only storing these data in MC. Hence this has to be an optional input.
      }
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_l1)
          or inputMetaStore()->retrieve( m_l1Json, m_metaNameJSON_l1 ).isFailure() )
      {
         m_menuJSONContainerAvailable = false;
      }
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_hltps)
          or inputMetaStore()->retrieve( m_hltpsJson, m_metaNameJSON_hltps ).isFailure() )
      {
         m_menuJSONContainerAvailable = false;
      }
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_l1ps)
          or inputMetaStore()->retrieve( m_l1psJson, m_metaNameJSON_l1ps ).isFailure() )
      {
         m_menuJSONContainerAvailable = false;
      }
      if( !inputMetaStore()->contains<xAOD::TriggerMenuJsonContainer>(m_metaNameJSON_bg)
          or inputMetaStore()->retrieve( m_bgJson, m_metaNameJSON_bg ).isFailure() ) {
         // m_menuJSONContainerAvailable = false;
         // This was not written up to the end of 2021, we have to make it optional for at least a while
      }
 
 
      if( !m_triggerMenuContainerAvailable && !m_menuJSONContainerAvailable ) {
         ATH_MSG_WARNING( "No trigger configurations are available on "
                          "the input" );
         return StatusCode::SUCCESS;
      }
 
      // Prefer run three format, if available
      if (m_menuJSONContainerAvailable) {
 
         // A little sanity check:
         if( m_hltJson->size() == 0 ) {
            // This can happen when we encounter empty input files. In which
            // case we should not bail, but continue, and only bail if by the
            // start of an event, we still don't see any configurations.
            ATH_MSG_WARNING( "No trigger configurations are available on "
                             "the input" );
            return StatusCode::SUCCESS;
         }
 
         // Load the first elements by default
         ATH_CHECK( m_hltJson->size() > 0 );
         //ATH_CHECK( m_hltmonitoringJson->size() > 0 ); // Optional - re-enable this check in the future when all used AODs contains this
         ATH_CHECK( m_l1Json->size() > 0 );
         ATH_CHECK( m_hltpsJson->size() > 0 );
         ATH_CHECK( m_l1psJson->size() > 0 );
         if (m_bgJson) { // Considered optional for now
            ATH_CHECK( m_bgJson->size() > 0 );
         }
 
         m_currentHltJson = m_hltJson->at( 0 );
         if (m_hltmonitoringJson && m_hltmonitoringJson->size()) { // Optional
            m_currentHltmonitoringJson = m_hltmonitoringJson->at( 0 );
         }
         m_currentL1Json = m_l1Json->at( 0 );
         m_currentHltpsJson = m_hltpsJson->at( 0 );
         m_currentL1psJson = m_l1psJson->at( 0 );
         if (m_bgJson) {  // Considered optional for now
            m_currentBgJson = m_bgJson->at( 0 );
         }
 
         ATH_CHECK( loadPtrees() );
 
         // Loading the payload doesn't additionally let the object know about its own key. We can load this in now too.
         m_impl->m_currentHlt.setSMK( m_currentHltJson->key() );
         if (m_currentHltmonitoringJson) { // Optional
            m_impl->m_currentHltmonitoring.setSMK( m_currentHltmonitoringJson->key() );
         }
         m_impl->m_currentL1.setSMK( m_currentL1Json->key() );
         m_impl->m_currentHltps.setPSK( m_currentHltpsJson->key() );
         m_impl->m_currentL1ps.setPSK( m_currentL1psJson->key() );
         if (m_bgJson) { // Optional (for now)
            m_impl->m_currentBg.setBGSK( m_currentBgJson->key() );
         }
 
         ATH_CHECK( prepareTriggerMenu( m_impl->m_currentHlt,
                                        m_impl->m_currentL1,
                                        m_impl->m_currentHltps,
                                        m_impl->m_currentL1ps,
                                        m_impl->m_currentBg,
                                        m_impl->m_ctpConfig,
                                        m_impl->m_chainList,
                                        m_impl->m_sequenceList,
                                        m_impl->m_bgSet, msg() ) );
 
         return StatusCode::SUCCESS;
 
      } else if (m_triggerMenuContainerAvailable) {
 
         // A little sanity check:
         if( m_tmc->size() == 0 ) {
            // This can happen when we encounter empty input files. In which
            // case we should not bail, but continue, and only bail if by the
            // start of an event, we still don't see any configurations.
            ATH_MSG_WARNING( "No trigger configurations are available on "
                             "the input" );
            return StatusCode::SUCCESS;
         }
 
         m_menu = m_tmc->at( 0 );
         // Cache the menu's configuration:
         ATH_CHECK( prepareTriggerMenu( m_menu, m_impl->m_ctpConfig,
                                        m_impl->m_chainList,
                                        m_impl->m_sequenceList,
                                        m_impl->m_bgSet, msg() ) );
 
         return StatusCode::SUCCESS;
      }
 
      ATH_MSG_ERROR( "Both m_menuJSONContainerAvailable and m_triggerMenuContainerAvailable are false");
      return StatusCode::FAILURE; // Should never get here as checked that one or the other is true above
   }

◆ bunchGroupSet()

const BunchGroupSet * TrigConf::xAODConfigTool::bunchGroupSet ( ) const

overridevirtual

Get the LVL1 bunch group set.

Implements TrigConf::IILVL1ConfigSvc.

Definition at line 125 of file xAODConfigTool.cxx.

                                                            {
      // Check if the object is well prepared:
      if( m_impl->m_bgSet.bunchGroups().size() == 0 ) {
         ATH_MSG_FATAL( "Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
 
      // Return the pointer:
      return &m_impl->m_bgSet;
   }

◆ bunchGroupSetKey()

uint32_t TrigConf::xAODConfigTool::bunchGroupSetKey ( ) const

overridevirtual

Get the LVL1 bunch group set key.

Implements TrigConf::IILVL1ConfigSvc.

Definition at line 155 of file xAODConfigTool.cxx.

   {
      if (m_menuJSONContainerAvailable)
         return m_impl->m_currentBg.bgsk();
      else {
         ATH_MSG_DEBUG("There's no way to access the bunch group set key from a legacy AOD!");
         return std::numeric_limits<uint32_t>::max();
      }
   }

◆ chains()

const HLTChainList & TrigConf::xAODConfigTool::chains ( ) const

overridevirtual

Get the HLT chains.

Implements TrigConf::IIHLTConfigSvc.

Definition at line 165 of file xAODConfigTool.cxx.

                                                    {
      // Check if the object is well prepared:
      if( m_impl->m_chainList.size() == 0 ) {
         ATH_MSG_FATAL( "Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
 
      // Return the object:
      return m_impl->m_chainList;
   }

◆ ctpConfig()

const CTPConfig * TrigConf::xAODConfigTool::ctpConfig ( ) const

overridevirtual

Get the LVL1 trigger menu.

Implements TrigConf::IILVL1ConfigSvc.

Definition at line 114 of file xAODConfigTool.cxx.

                                                    {
      // Check if the object is well prepared:
      if( m_impl->m_ctpConfig.menu().size() == 0 ) {
         ATH_MSG_FATAL( "Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
 
      // Return the pointer:
      return &m_impl->m_ctpConfig;
   }

◆ 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

◆ endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      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.

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

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                     {
 
      // Tell the user what's happening:
      ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
      // Call the appropriate member function:
      if( inc.type() == IncidentType::BeginInputFile ) {
        m_beginInputFileCalled = true;
        if( beginInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call beginInputFile()" );
          throw std::runtime_error( "Couldn't call beginInputFile()" );
         }
      } else if( inc.type() == IncidentType::EndInputFile ) {
        if( endInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call endInputFile()" );
          throw std::runtime_error( "Couldn't call endInputFile()" );
         }
      } else if( inc.type() == IncidentType::BeginEvent ) {
         // If the tool didn't catch the begin input file incident for the
         // first input file of the job, then call the appropriate function
         // now.
         if( ! m_beginInputFileCalled ) {
            m_beginInputFileCalled = true;
            if( beginInputFile().isFailure() ) {
               ATH_MSG_FATAL( "Failed to call beginInputFile()" );
               throw std::runtime_error( "Couldn't call beginInputFile()" );
            }
         }
         if( beginEvent().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call beginEvent()" );
            throw std::runtime_error( "Couldn't call beginEvent()" );
         }
 
     #ifdef XAOD_STANDALONE
      } else if( inc.type() == IncidentType::MetaDataStop ) {
         if( metaDataStop().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call metaDataStop()" );
            throw std::runtime_error( "Couldn't call metaDataStop()" );
         }
         
     #endif // XAOD_STANDALONE
      } else {
         ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
      }
 
      return;
   }

◆ hltMenu() [1/2]

virtual const ::TrigConf::HLTMenu & TrigConf::IIHLTConfigSvc::hltMenu ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured HLTMenu ptree.

◆ hltMenu() [2/2]

const HLTMenu & TrigConf::xAODConfigTool::hltMenu ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured HLTMenu ptree.

Definition at line 225 of file xAODConfigTool.cxx.

                                                                   {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentHlt;
   }

◆ hltMonitoring() [1/2]

virtual const ::TrigConf::HLTMonitoring & TrigConf::IIHLTConfigSvc::hltMonitoring ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured HLTMonitoring ptree.

◆ hltMonitoring() [2/2]

const HLTMonitoring & TrigConf::xAODConfigTool::hltMonitoring ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured HLTMonitoring ptree.

Definition at line 233 of file xAODConfigTool.cxx.

                                                                               {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentHltmonitoring;
   }

◆ hltPrescaleKey()

uint32_t TrigConf::xAODConfigTool::hltPrescaleKey ( ) const

overridevirtual

Get the HLT prescale key.

Implements TrigConf::IIHLTConfigSvc.

Definition at line 206 of file xAODConfigTool.cxx.

                                                 {
      if (m_menuJSONContainerAvailable) {
 
         return m_currentHltpsJson->key();
 
      } else {
 
         // Check if the object is well prepared:
         if( ! m_menu ) {
            ATH_MSG_FATAL( "Trigger menu not loaded" );
            throw std::runtime_error( "Tool not initialised correctly" );
         }
 
         // Return the key from the metadata object:
         return m_menu->hltpsk();
 
      }
   }

◆ hltPrescalesSet() [1/2]

virtual const ::TrigConf::HLTPrescalesSet & TrigConf::IIHLTConfigSvc::hltPrescalesSet ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured HLT prescales ptree.

◆ hltPrescalesSet() [2/2]

const HLTPrescalesSet & TrigConf::xAODConfigTool::hltPrescalesSet ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured HLT prescales ptree.

Definition at line 249 of file xAODConfigTool.cxx.

                                                                                   {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentHltps;
   }

◆ initialize()

StatusCode TrigConf::xAODConfigTool::initialize ( void )

overridevirtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 78 of file xAODConfigTool.cxx.

                                         {
 
      // Greet the user:
      ATH_MSG_INFO( "Initialising..." );
      ATH_MSG_DEBUG( "EventObjectName = " << m_eventName );
      ATH_MSG_DEBUG( "-- Run 2 AOD Configuration Settings");
      ATH_MSG_DEBUG( "MetaObjectName  = " << m_metaName_run2 );
      ATH_MSG_DEBUG( "-- Run 3 AOD Configuration Settings");
      ATH_MSG_DEBUG( "JSONMetaObjectNameHLT = " << m_metaNameJSON_hlt );
      ATH_MSG_DEBUG( "JSONMetaObjectNameHLTMonitoring = " << m_metaNameJSON_hltmonitoring );
      ATH_MSG_DEBUG( "JSONMetaObjectNameL1 = " << m_metaNameJSON_l1 );
      ATH_MSG_DEBUG( "JSONMetaObjectNameHLTPS = " << m_metaNameJSON_hltps );
      ATH_MSG_DEBUG( "JSONMetaObjectNameL1PS = " << m_metaNameJSON_l1ps );
      ATH_MSG_DEBUG( "JSONMetaObjectNameBunchgroup = " << m_metaNameJSON_bg );
 
      // Reset the pointers:
      m_tmc = nullptr;
      m_menu = nullptr;
      //
      m_hltJson = nullptr;
      m_hltmonitoringJson = nullptr;
      m_l1Json = nullptr;
      m_hltpsJson = nullptr;
      m_l1psJson = nullptr;
      m_bgJson = nullptr;
      m_currentHltJson = nullptr;
      m_currentHltmonitoringJson = nullptr;
      m_currentL1Json = nullptr;
      m_currentHltpsJson = nullptr;
      m_currentL1psJson = nullptr;
      m_currentBgJson = nullptr;
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ 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.

◆ inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                       {
 
#ifdef XAOD_STANDALONE
      return &m_inputMetaStore;
#else // XAOD_STANDALONE
      return m_inputMetaStore;
#endif // XAOD_STANDALONE
   }

◆ l1BunchGroupSet() [1/2]

virtual const ::TrigConf::L1BunchGroupSet & TrigConf::IILVL1ConfigSvc::l1BunchGroupSet ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured bunchgroup ptree.

◆ l1BunchGroupSet() [2/2]

const L1BunchGroupSet & TrigConf::xAODConfigTool::l1BunchGroupSet ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured bunchgroup ptree.

Definition at line 265 of file xAODConfigTool.cxx.

                                                                                   {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentBg;
   }

◆ l1Menu() [1/2]

virtual const ::TrigConf::L1Menu & TrigConf::IILVL1ConfigSvc::l1Menu ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured L1 ptree.

◆ l1Menu() [2/2]

const L1Menu & TrigConf::xAODConfigTool::l1Menu ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured L1 ptree.

Definition at line 241 of file xAODConfigTool.cxx.

                                                                 {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentL1;
   }

◆ l1PrescalesSet() [1/2]

virtual const ::TrigConf::L1PrescalesSet & TrigConf::IILVL1ConfigSvc::l1PrescalesSet ( const ::EventContext & ctx ) const

pure virtualinherited

Returns the JSON configured L1 prescales ptree.

◆ l1PrescalesSet() [2/2]

const L1PrescalesSet & TrigConf::xAODConfigTool::l1PrescalesSet ( const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Returns the JSON configured L1 prescales ptree.

Definition at line 257 of file xAODConfigTool.cxx.

                                                                                 {
      if( ! m_menuJSONContainerAvailable ) {
         ATH_MSG_FATAL( "Run 3 format Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
      return m_impl->m_currentL1ps;
   }

◆ loadJsonByKey()

StatusCode TrigConf::xAODConfigTool::loadJsonByKey	(	const std::string &	humanName,
		const xAOD::TriggerMenuJsonContainer *	metaContainer,
		const uint32_t	keyToCheck,
		const xAOD::TriggerMenuJson *&	ptrToSet )

private

Locates a Run3 TriggerMenuJson object inside a container by key. Loads it into the m_currentXXXJson ptr.

Definition at line 553 of file xAODConfigTool.cxx.

   {
      xAOD::TriggerMenuJsonContainer::const_iterator menu_itr = metaContainer->begin();
      xAOD::TriggerMenuJsonContainer::const_iterator menu_end = metaContainer->end();
      for( ; menu_itr != menu_end; ++menu_itr ) {
         // Check if this is the menu we're looking for:
         if( keyToCheck != (*menu_itr)->key() ) continue;
         ptrToSet = *menu_itr;
         return StatusCode::SUCCESS;
      }
 
      ATH_MSG_FATAL("Couldn't find configuration for current event"
         << ", Requested key=" << keyToCheck
         << ", Requested menu=" << humanName);
      return StatusCode::FAILURE;
   }

◆ loadPtree()

StatusCode TrigConf::xAODConfigTool::loadPtree	(	const std::string &	humanName,
		const xAOD::TriggerMenuJson *	menu,
		DataStructure &	dataStructure )

private

Load single m_currentXXXJson serialised JSON data into ptree.

Definition at line 587 of file xAODConfigTool.cxx.

   {
      std::stringstream rawData;
      rawData << menu->payload();
      dataStructure.clear();
      try {
         boost::property_tree::ptree pt;
         boost::property_tree::read_json(rawData, pt);
         dataStructure.setData(std::move(pt));
      } catch (const boost::property_tree::json_parser_error& e) {
         ATH_MSG_FATAL("Unable to decode a JSON trigger menu metadata payload for " << humanName << " with key " << menu->key());
         ATH_MSG_FATAL(e.what());
         return StatusCode::FAILURE;
      }
      return StatusCode::SUCCESS;
   }

◆ loadPtrees()

StatusCode TrigConf::xAODConfigTool::loadPtrees ( )

private

Load all m_currentXXXJson serialised JSON data into ptrees inside m_impl.

Definition at line 573 of file xAODConfigTool.cxx.

                                         {
      ATH_CHECK( loadPtree("HLT Menu", m_currentHltJson, m_impl->m_currentHlt) );
      if (m_currentHltmonitoringJson) {
         ATH_CHECK( loadPtree("HLT Monitoring", m_currentHltmonitoringJson, m_impl->m_currentHltmonitoring) );
      }
      ATH_CHECK( loadPtree("L1 Menu", m_currentL1Json, m_impl->m_currentL1) );
      ATH_CHECK( loadPtree("HLT Prescales", m_currentHltpsJson, m_impl->m_currentHltps) );
      ATH_CHECK( loadPtree("L1 Prescales", m_currentL1psJson, m_impl->m_currentL1ps) );
      if (m_bgJson) {
         ATH_CHECK( loadPtree("Bunchgroups", m_currentBgJson, m_impl->m_currentBg) );
      }
      return StatusCode::SUCCESS;
   }

◆ lvl1PrescaleKey()

uint32_t TrigConf::xAODConfigTool::lvl1PrescaleKey ( ) const

overridevirtual

Get the LVL1 prescale key.

Implements TrigConf::IILVL1ConfigSvc.

Definition at line 136 of file xAODConfigTool.cxx.

                                                  {
      if ( m_menuJSONContainerAvailable ) {
 
         return m_currentL1psJson->key();
 
      } else {
 
         // Check if the object is well prepared:
         if( ! m_menu ) {
            ATH_MSG_FATAL( "Trigger menu not loaded" );
            throw std::runtime_error( "Tool not initialised correctly" );
         }
 
         // Return the key from the metadata object:
         return m_menu->l1psk();
 
      }
   }

◆ masterKey()

uint32_t TrigConf::xAODConfigTool::masterKey ( ) const

overridevirtual

Get the Super Master Key.

Implements TrigConf::IIHLTConfigSvc.

Definition at line 187 of file xAODConfigTool.cxx.

                                            {
      if (m_menuJSONContainerAvailable) {
 
         return m_currentHltJson->key();
 
      } else {
 
         // Check if the object is well prepared:
         if( ! m_menu ) {
            ATH_MSG_FATAL( "Trigger menu not loaded" );
            throw std::runtime_error( "Tool not initialised correctly" );
         }
 
         // Return the key from the metadata object:
         return m_menu->smk();
 
      }
   }

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

◆ 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.

◆ outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                        {
 
#ifdef XAOD_STANDALONE
      return &m_outputMetaStore;
#else // XAOD_STANDALONE
      return m_outputMetaStore;
#endif // XAOD_STANDALONE
   }

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

◆ 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();
  }

◆ sequences()

const HLTSequenceList & TrigConf::xAODConfigTool::sequences ( ) const

overridevirtual

Get the HLT sequences.

Implements TrigConf::IIHLTConfigSvc.

Definition at line 176 of file xAODConfigTool.cxx.

                                                          {
      // Check if the object is well prepared:
      if( m_impl->m_sequenceList.size() == 0 ) {
         ATH_MSG_FATAL( "Trigger menu not loaded" );
         throw std::runtime_error( "Tool not initialised correctly" );
      }
 
      // Return the object:
      return m_impl->m_sequenceList;
   }

◆ setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

   {
      m_useIncidents = flag;
   }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                             {
 
#ifndef XAOD_STANDALONE
      if (m_useIncidents) {
         // Connect to the IncidentSvc:
         ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
         ATH_CHECK( incSvc.retrieve() );
 
         // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
         incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
      }
      // Let the base class do its thing:
      ATH_CHECK( AlgTool::sysInitialize() );
 
#endif // not XAOD_STANDALONE
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ 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.

◆ thresholdConfig()

virtual const ThresholdConfig * TrigConf::xAODConfigTool::thresholdConfig ( ) const

inlineoverridevirtual

Get the LVL1 threshold configuruation (not available from xAOD)

Implements TrigConf::IILVL1ConfigSvc.

Definition at line 82 of file xAODConfigTool.h.

                                                                      {
         return 0;
      }

◆ 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_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

◆ m_bgJson

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_bgJson

private

Definition at line 198 of file xAODConfigTool.h.

◆ m_bgkeysName

std::string TrigConf::xAODConfigTool::m_bgkeysName

private

Key for the event-level bunchgroup identification object, in the codebase since R2 but only being used since R3.

Definition at line 179 of file xAODConfigTool.h.

◆ m_currentBgJson

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentBgJson

private

Definition at line 208 of file xAODConfigTool.h.

◆ m_currentHltJson

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentHltJson

private

The active configuration for the current event (For Run3 AOD)

Definition at line 203 of file xAODConfigTool.h.

◆ m_currentHltmonitoringJson

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentHltmonitoringJson

private

Definition at line 204 of file xAODConfigTool.h.

◆ m_currentHltpsJson

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentHltpsJson

private

Definition at line 206 of file xAODConfigTool.h.

◆ m_currentL1Json

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentL1Json

private

Definition at line 205 of file xAODConfigTool.h.

◆ m_currentL1psJson

const xAOD::TriggerMenuJson* TrigConf::xAODConfigTool::m_currentL1psJson

private

Definition at line 207 of file xAODConfigTool.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_eventName

std::string TrigConf::xAODConfigTool::m_eventName

private

Key for the event-level configuration identifier object.

Definition at line 177 of file xAODConfigTool.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_hltJson

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_hltJson

private

The configuration object of the current input file (for Run3 AOD)

Definition at line 193 of file xAODConfigTool.h.

◆ m_hltmonitoringJson

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_hltmonitoringJson

private

Definition at line 194 of file xAODConfigTool.h.

◆ m_hltpsJson

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_hltpsJson

private

Definition at line 196 of file xAODConfigTool.h.

◆ m_impl

std::unique_ptr<Impl> TrigConf::xAODConfigTool::m_impl

private

Definition at line 222 of file xAODConfigTool.h.

◆ m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_l1Json

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_l1Json

private

Definition at line 195 of file xAODConfigTool.h.

◆ m_l1psJson

const xAOD::TriggerMenuJsonContainer* TrigConf::xAODConfigTool::m_l1psJson

private

Definition at line 197 of file xAODConfigTool.h.

◆ m_menu

const xAOD::TriggerMenu* TrigConf::xAODConfigTool::m_menu

private

The active configuration for the current event (For Run2 AOD)

Definition at line 201 of file xAODConfigTool.h.

◆ m_menuJSONContainerAvailable

bool TrigConf::xAODConfigTool::m_menuJSONContainerAvailable

private

Is decoded R3 format data available?

Definition at line 213 of file xAODConfigTool.h.

◆ m_metaName_run2

std::string TrigConf::xAODConfigTool::m_metaName_run2

private

Key for the trigger configuration metadata object (Run 2)

Definition at line 181 of file xAODConfigTool.h.

◆ m_metaNameJSON_bg

std::string TrigConf::xAODConfigTool::m_metaNameJSON_bg

private

Definition at line 188 of file xAODConfigTool.h.

◆ m_metaNameJSON_hlt

std::string TrigConf::xAODConfigTool::m_metaNameJSON_hlt

private

Key for the trigger configuration metadata objects (Run 3)

Definition at line 183 of file xAODConfigTool.h.

◆ m_metaNameJSON_hltmonitoring

std::string TrigConf::xAODConfigTool::m_metaNameJSON_hltmonitoring

private

Definition at line 184 of file xAODConfigTool.h.

◆ m_metaNameJSON_hltps

std::string TrigConf::xAODConfigTool::m_metaNameJSON_hltps

private

Definition at line 186 of file xAODConfigTool.h.

◆ m_metaNameJSON_l1

std::string TrigConf::xAODConfigTool::m_metaNameJSON_l1

private

Definition at line 185 of file xAODConfigTool.h.

◆ m_metaNameJSON_l1ps

std::string TrigConf::xAODConfigTool::m_metaNameJSON_l1ps

private

Definition at line 187 of file xAODConfigTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_tmc

const xAOD::TriggerMenuContainer* TrigConf::xAODConfigTool::m_tmc

private

The configuration object of the current input file (for Run2 AOD)

Definition at line 191 of file xAODConfigTool.h.

◆ m_triggerMenuContainerAvailable

bool TrigConf::xAODConfigTool::m_triggerMenuContainerAvailable

private

Is decoded R2 format data available?

Definition at line 211 of file xAODConfigTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.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:

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ xAODConfigTool()

◆ ~xAODConfigTool()

Member Function Documentation

◆ beginEvent()

◆ beginEvent_Run2()

◆ beginEvent_Run3()

◆ beginInputFile()

◆ bunchGroupSet()

◆ bunchGroupSetKey()

◆ chains()

◆ ctpConfig()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ endInputFile()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ handle()

◆ hltMenu() [1/2]

◆ hltMenu() [2/2]

◆ hltMonitoring() [1/2]

◆ hltMonitoring() [2/2]

◆ hltPrescaleKey()

◆ hltPrescalesSet() [1/2]

◆ hltPrescalesSet() [2/2]

◆ initialize()

◆ inputHandles()

◆ inputMetaStore()

◆ l1BunchGroupSet() [1/2]

◆ l1BunchGroupSet() [2/2]

◆ l1Menu() [1/2]

◆ l1Menu() [2/2]

◆ l1PrescalesSet() [1/2]

◆ l1PrescalesSet() [2/2]

◆ loadJsonByKey()

◆ loadPtree()

◆ loadPtrees()

◆ lvl1PrescaleKey()

◆ masterKey()

◆ metaDataStop()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sequences()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ thresholdConfig()

◆ updateVHKA()

Member Data Documentation

◆ m_beginInputFileCalled

◆ m_bgJson

◆ m_bgkeysName

◆ m_currentBgJson

◆ m_currentHltJson

◆ m_currentHltmonitoringJson

◆ m_currentHltpsJson

◆ m_currentL1Json

◆ m_currentL1psJson