HLTResultMTMaker Class Reference

Tool to create the HLTResultMT at the end of each event. More...

#include <HLTResultMTMaker.h>

Inheritance diagram for HLTResultMTMaker:

Collaboration diagram for HLTResultMTMaker:

Public Member Functions
	HLTResultMTMaker (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
virtual	~HLTResultMTMaker () override=default
	Standard destructor. More...
virtual StatusCode	initialize () override
virtual StatusCode	start () override
virtual StatusCode	finalize () override
StatusCode	makeResult (const EventContext &eventContext) const
	Create and fill a new HLTResultMT, and record it in the event store. More...
StatusCode	fillResult (HLT::HLTResultMT &hltResult, const EventContext &eventContext) const
	Fill an existing HLTResultMT with event information. More...
const std::string &	resultName () const
	Return name of the HLTResultMT. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	validatePEBInfo (HLT::HLTResultMT &hltResult) const
	Check ROB and SubDet lists in StreamTags and remove those which are disabled. More...
StatusCode	validateExtraROBsAndSubDets ()
	Check ExtraROBs and ExtraSubDets against the detector mask and drop the masked out IDs. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::WriteHandleKey< HLT::HLTResultMT >	m_hltResultWHKey
	StoreGate key for the HLTResultMT. More...
SG::WriteHandleKey< xAOD::TrigCompositeContainer >	m_runtimeMetadataWHKey
	StoreGate key for HLT Runtime Metadata container. More...
SG::ReadHandleKey< ByteStreamMetadataContainer >	m_bsMetaDataContRHKey
	StoreGate key for the ByteStreamMetadata container to retrieve detector mask. More...
ToolHandle< HLTResultMTMakerTool >	m_streamTagMaker
	Tool creating stream tags (defines if event is accepted) More...
ToolHandleArray< HLTResultMTMakerTool >	m_makerTools
	Tools filling the HLTResultMT object. More...
ToolHandle< GenericMonitoringTool >	m_monTool
	Monitoring tool. More...
ServiceHandle< Gaudi::Interfaces::IOptionsSvc >	m_jobOptionsSvc
	Handle to JobOptionsSvc used to retrieve the DataFlowConfig property. More...
Gaudi::Property< std::vector< uint32_t > >	m_extraEnabledROBs
	Extra enabled ROBs. More...
Gaudi::Property< std::vector< uint32_t > >	m_extraROBs
	Extra enabled ROBs checked against detector mask. More...
Gaudi::Property< std::vector< uint32_t > >	m_extraEnabledSubDets
	Extra enabled SubDets. More...
Gaudi::Property< std::vector< uint32_t > >	m_extraSubDets
	Extra enabled SubDets checked against detector mask. More...
std::set< uint32_t >	m_enabledROBs
	List of enabled ROBs retrieved during initialisation. More...
std::set< eformat::SubDetector >	m_enabledSubDets
	List of enabled SubDets retrieved during initialisation. More...
bool	m_skipValidatePEBInfo {false}
	If true, don't call validatePEBInfo. More...
std::atomic_bool	m_emptyPEBInfoErrorPrinted {false}
	Flag if empty PEB list error was already printed. More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to create the HLTResultMT at the end of each event.

Definition at line 29 of file HLTResultMTMaker.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

HLTResultMTMaker()

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

Standard constructor.

Definition at line 58 of file HLTResultMTMaker.cxx.

  : AthAlgTool(type, name, parent) {}

~HLTResultMTMaker()

virtual HLTResultMTMaker::~HLTResultMTMaker ( )

overridevirtualdefault

Standard destructor.

Member Function Documentation

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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; }

evtStore() [1/2]

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; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 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

fillResult()

StatusCode HLTResultMTMaker::fillResult	(	HLT::HLTResultMT &	hltResult,
		const EventContext &	eventContext
	)		const

Fill an existing HLTResultMT with event information.

Definition at line 150 of file HLTResultMTMaker.cxx.

                                                                                                         {
  auto monTime =  Monitored::Timer<std::chrono::duration<float, std::milli>>("TIME_fillResult");
 
  // Save HLT runtime metadata
  SG::WriteHandle<xAOD::TrigCompositeContainer> runtimeMetadataOutput = TrigCompositeUtils::createAndStore(m_runtimeMetadataWHKey, eventContext);
  runtimeMetadataOutput->push_back(std::make_unique<xAOD::TrigComposite>());
  char hostname [HOST_NAME_MAX];
  bool errcode = !gethostname(hostname, HOST_NAME_MAX); // returns 0 on success and -1 on failure, casted to false on success, true on failure
  std::string hostnameString = std::string(hostname); // setDetail needs a reference
  errcode &= runtimeMetadataOutput->back()->setDetail("hostname", hostnameString);
  if (!errcode) ATH_MSG_WARNING("Failed to append hostname to HLT Runtime Metadata TC");
 
  // Fill the stream tags
  StatusCode finalStatus = StatusCode::SUCCESS;
  if (m_streamTagMaker.isEnabled() && m_streamTagMaker->fill(hltResult, eventContext).isFailure()) {
    ATH_MSG_ERROR(m_streamTagMaker->name() << " failed");
    finalStatus = StatusCode::FAILURE;
  }
 
  // Fill the result using all other tools if the event was accepted
  if (hltResult.isAccepted()) {
    for (auto& maker: m_makerTools) {
      ATH_MSG_DEBUG("Calling " << maker->name() << " for accepted event");
      if (StatusCode sc = maker->fill(hltResult, eventContext); sc.isFailure()) {
        ATH_MSG_ERROR(maker->name() << " failed");
        finalStatus = sc;
      }
    }
 
    if (!m_skipValidatePEBInfo) validatePEBInfo(hltResult);
  }
  else {
    ATH_MSG_DEBUG("Rejected event, further result filling skipped after stream tag maker");
  }
 
  ATH_MSG_DEBUG(hltResult);
 
  Monitored::Group(m_monTool, monTime);
  return finalStatus;
}

finalize()

StatusCode HLTResultMTMaker::finalize ( )

overridevirtual

Definition at line 131 of file HLTResultMTMaker.cxx.

                                      {
  ATH_CHECK(m_monTool.release());
  return StatusCode::SUCCESS;
}

initialize()

StatusCode HLTResultMTMaker::initialize ( )

overridevirtual

Definition at line 64 of file HLTResultMTMaker.cxx.

                                        {
  ATH_CHECK(m_hltResultWHKey.initialize());
  ATH_CHECK(m_runtimeMetadataWHKey.initialize());
  ATH_CHECK(m_streamTagMaker.retrieve(DisableTool{m_streamTagMaker.name().empty()}));
  ATH_CHECK(m_makerTools.retrieve());
  ATH_CHECK(m_monTool.retrieve(DisableTool{m_monTool.empty()}));
  ATH_CHECK(m_jobOptionsSvc.retrieve());
  ATH_CHECK(m_bsMetaDataContRHKey.initialize(!m_extraROBs.empty() || !m_extraSubDets.empty()));
 
  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.

makeResult()

StatusCode HLTResultMTMaker::makeResult

(

const EventContext &

eventContext

)

const

Create and fill a new HLTResultMT, and record it in the event store.

Definition at line 139 of file HLTResultMTMaker.cxx.

                                                                              {
  auto hltResult = SG::makeHandle(m_hltResultWHKey,eventContext);
  ATH_CHECK( hltResult.record(std::make_unique<HLT::HLTResultMT>()) );
  ATH_MSG_DEBUG("Recorded HLTResultMT with key " << m_hltResultWHKey.key());
  ATH_CHECK(fillResult(*hltResult, eventContext));
  return StatusCode::SUCCESS;
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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

resultName()

const std::string& HLTResultMTMaker::resultName ( ) const

inline

Return name of the HLTResultMT.

Definition at line 47 of file HLTResultMTMaker.h.

{return m_hltResultWHKey.key();}

start()

StatusCode HLTResultMTMaker::start ( )

overridevirtual

Definition at line 80 of file HLTResultMTMaker.cxx.

                                   {
  // DataFlowConfig is a special object used online to hold DF properties passed from TDAQ to HLT as run parameters.
  Gaudi::Property<std::vector<uint32_t>> enabledROBsProp("EnabledROBs",{});
  if (enabledROBsProp.fromString(m_jobOptionsSvc->get("DataFlowConfig.DF_Enabled_ROB_IDs","[]")).isSuccess()) {
    m_enabledROBs.insert(enabledROBsProp.value().begin(), enabledROBsProp.value().end());
    ATH_MSG_DEBUG("Retrieved a list of " << m_enabledROBs.size()
                  << " ROBs from DataFlowConfig.DF_Enabled_ROB_IDs");
  }
  else {
    ATH_MSG_ERROR("Could not parse DataFlowConfig.DF_Enabled_ROB_IDs from JobOptionsSvc");
  }
 
  m_enabledSubDets.clear();
  Gaudi::Property<std::vector<uint32_t>> enabledSubDetsProp("EnabledSubDets",{});
  if (enabledSubDetsProp.fromString(m_jobOptionsSvc->get("DataFlowConfig.DF_Enabled_SubDet_IDs","[]")).isSuccess()) {
    // Need to convert from uint32_t to eformat::SubDetector representable by uint8_t
    for (const uint32_t id : enabledSubDetsProp.value()) {
      m_enabledSubDets.insert( static_cast<eformat::SubDetector>(id & 0xFF) );
    }
    ATH_MSG_DEBUG("Retrieved a list of " << m_enabledSubDets.size()
                  << " SubDets from DataFlowConfig.DF_Enabled_SubDet_IDs");
  }
  else {
    ATH_MSG_ERROR("Could not parse DataFlowConfig.DF_Enabled_SubDet_IDs from JobOptionsSvc");
  }
 
  if (m_enabledROBs.empty() && m_enabledSubDets.empty()) {
    m_skipValidatePEBInfo = true;
    ATH_MSG_INFO("The list of enabled ROBs and SubDets was not provided by DataFlowConfig or is empty. "
                 << "StreamTag PEBInfo validation will be skipped.");
  }
  else {
    ATH_CHECK(validateExtraROBsAndSubDets());
    m_enabledROBs.insert(m_extraEnabledROBs.value().begin(), m_extraEnabledROBs.value().end());
    m_enabledROBs.insert(m_extraROBs.value().begin(), m_extraROBs.value().end());
    // Need to convert from uint32_t to eformat::SubDetector representable by uint8_t
    for (const uint32_t id : m_extraEnabledSubDets.value()) {
      m_enabledSubDets.insert( static_cast<eformat::SubDetector>(id & 0xFF) );
    }
    for (const uint32_t id : m_extraSubDets.value()) {
      m_enabledSubDets.insert( static_cast<eformat::SubDetector>(id & 0xFF) );
    }
    ATH_MSG_INFO("StreamTag PEBInfo will be validated against " << m_enabledROBs.size() << " enabled ROBs and "
                 << m_enabledSubDets.size() << " enabled SubDets");
  }
  return StatusCode::SUCCESS;
}

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

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

validateExtraROBsAndSubDets()

StatusCode HLTResultMTMaker::validateExtraROBsAndSubDets ( )

private

Check ExtraROBs and ExtraSubDets against the detector mask and drop the masked out IDs.

Definition at line 255 of file HLTResultMTMaker.cxx.

                                                         {
  if (m_extraROBs.empty() && m_extraSubDets.empty()) {
    // Nothing to check
    return StatusCode::SUCCESS;
  }
 
  // Get the detector mask
  auto bsmdc = SG::makeHandle(m_bsMetaDataContRHKey);
  ATH_CHECK(bsmdc.isValid());
  ATH_CHECK(!bsmdc->empty());
  const ByteStreamMetadata* metadata = bsmdc->front();
  const eformat::helper::DetectorMask detectorMask{metadata->getDetectorMask(), metadata->getDetectorMask2()};
 
  // Check ROBs
  std::vector<uint32_t> validatedExtraROBs;
  for (const uint32_t rob_id : m_extraROBs.value()) {
    const eformat::helper::SourceIdentifier sid{rob_id};
    const eformat::SubDetector subdet_id = sid.subdetector_id();
    if (detectorMask.is_set(subdet_id)) {
      validatedExtraROBs.push_back(rob_id);
    }
    else {
      ATH_MSG_WARNING("Removing 0x" << MSG::hex << rob_id << MSG::dec << " from " << m_extraROBs.name()
                      << " because SubDetector " << sid.human_detector() << " is disabled in the detector mask");
    }
  }
  m_extraROBs = validatedExtraROBs;
 
  // Check SubDets
  std::vector<uint32_t> validatedExtraSubDets;
  for (const uint32_t subdet_id32 : m_extraSubDets.value()) {
    const eformat::SubDetector subdet_id = static_cast<eformat::SubDetector>(subdet_id32 & 0xFF);
    if (detectorMask.is_set(subdet_id)) {
      validatedExtraSubDets.push_back(subdet_id32);
    }
    else {
      ATH_MSG_WARNING("Removing 0x" << MSG::hex << subdet_id << MSG::dec << " from " << m_extraSubDets.name()
                      << " because SubDetector " << eformat::helper::SourceIdentifier(subdet_id,0,0).human_detector()
                      << " is disabled in the detector mask");
    }
  }
  m_extraSubDets = validatedExtraSubDets;
 
  return StatusCode::SUCCESS;
}

validatePEBInfo()

void HLTResultMTMaker::validatePEBInfo ( HLT::HLTResultMT &  hltResult ) const

private

Check ROB and SubDet lists in StreamTags and remove those which are disabled.

Definition at line 194 of file HLTResultMTMaker.cxx.

                                                                      {
  std::vector<eformat::helper::StreamTag> streamTagsToRemove;
  for (eformat::helper::StreamTag& st : hltResult.getStreamTagsNonConst()) {
    // Skip full event building stream tags immediately
    if (st.robs.empty() && st.dets.empty()) {continue;}
 
    std::set<uint32_t> removedROBs = removeDisabled(st.robs,m_enabledROBs);
    if (!removedROBs.empty()) {
      ATH_MSG_DEBUG("StreamTag " << st.type << "_" << st.name << " requested disabled ROBs: " << format(removedROBs)
                    << " - these ROBs were removed from the StreamTag by " << name());
      std::vector<eformat::SubDetector> removedSubDets;
      for (const uint32_t rob : removedROBs) {
        eformat::SubDetector sd{eformat::helper::SourceIdentifier(rob).subdetector_id()};
        if (std::find(removedSubDets.begin(),removedSubDets.end(),sd)==removedSubDets.end()) {
          removedSubDets.push_back(sd);
        }
      }
      auto monRemovedROBsSubDet = Monitored::Collection(
        "PEB_RemovedROBs_SubDet", removedSubDets,
        [](const eformat::SubDetector sd){return eformat::helper::SubDetectorDictionary.string(sd);});
      Monitored::Group(m_monTool, monRemovedROBsSubDet);
    } else {
      ATH_MSG_VERBOSE("No disabled ROBs were requested by StreamTag " << st.type << "_" << st.name);
    }
 
    std::set<eformat::SubDetector> removedSubDets = removeDisabled(st.dets,m_enabledSubDets);
    if (!removedSubDets.empty()) {
      ATH_MSG_DEBUG("StreamTag " << st.type << "_" << st.name << " requested disabled SubDets: " << format(removedSubDets)
                    << " - these SubDets were removed from the StreamTag by " << name());
      std::vector<eformat::SubDetector> removedSubDetsVec(removedSubDets.begin(),removedSubDets.end());
      auto monRemovedSubDets = Monitored::Collection(
        "PEB_RemovedSubDets", removedSubDetsVec,
        [](const eformat::SubDetector sd){return eformat::helper::SubDetectorDictionary.string(sd);});
      Monitored::Group(m_monTool, monRemovedSubDets);
    } else {
      ATH_MSG_VERBOSE("No disabled SubDets were requested by StreamTag " << st.type << "_" << st.name);
    }
 
    // If the PEB list now became empty, it would turn PEB into FEB - prevent this and drop the stream tag (ATR-24378)
    if (st.robs.empty() && st.dets.empty()) {
      bool printed{false};
      if (m_emptyPEBInfoErrorPrinted.compare_exchange_strong(printed, true, std::memory_order_relaxed)) {
        ATH_MSG_ERROR("Event accepted to stream " << st.type << "_" << st.name << " but the streaming to this stream "
                      << "is forcibly prevented, because all requested ROBs/SubDets in the PEB list are disabled. "
                      << "ROBs: " << format(removedROBs) << ", SubDets: " << format(removedSubDets));
      }
      streamTagsToRemove.push_back(st);
    }
  }
  for (const eformat::helper::StreamTag& st : streamTagsToRemove) {
    auto it = 
      std::remove(hltResult.getStreamTagsNonConst().begin(),
                  hltResult.getStreamTagsNonConst().end(),
                  st);
    hltResult.getStreamTagsNonConst().resize (it - hltResult.getStreamTagsNonConst().begin());
  }
}

Member Data Documentation

m_bsMetaDataContRHKey

SG::ReadHandleKey<ByteStreamMetadataContainer> HLTResultMTMaker::m_bsMetaDataContRHKey

private

Initial value:

{
    this, "ByteStreamMetadataRHKey", "InputMetaDataStore+ByteStreamMetadata",
    "Key of the ByteStreamMetadataContainer to retrieve the detector mask"
  }

StoreGate key for the ByteStreamMetadata container to retrieve detector mask.

Definition at line 67 of file HLTResultMTMaker.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_emptyPEBInfoErrorPrinted

std::atomic_bool HLTResultMTMaker::m_emptyPEBInfoErrorPrinted {false}

mutableprivate

Flag if empty PEB list error was already printed.

Definition at line 120 of file HLTResultMTMaker.h.

m_enabledROBs

std::set<uint32_t> HLTResultMTMaker::m_enabledROBs

private

List of enabled ROBs retrieved during initialisation.

Definition at line 114 of file HLTResultMTMaker.h.

m_enabledSubDets

std::set<eformat::SubDetector> HLTResultMTMaker::m_enabledSubDets

private

List of enabled SubDets retrieved during initialisation.

Definition at line 116 of file HLTResultMTMaker.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_extraEnabledROBs

Gaudi::Property<std::vector<uint32_t> > HLTResultMTMaker::m_extraEnabledROBs

private

Initial value:

{
    this, "ExtraEnabledROBs", {},
    "Extra ROBs which can be requested in a stream tag, but are not part of the ROS-ROB map"
  }

Extra enabled ROBs.

Definition at line 92 of file HLTResultMTMaker.h.

m_extraEnabledSubDets

Gaudi::Property<std::vector<uint32_t> > HLTResultMTMaker::m_extraEnabledSubDets

private

Initial value:

{
    this, "ExtraEnabledSubDets", {},
    "Extra SubDets which can be requested in a stream tag, but are not part of the ROS-ROB map"
  }

Extra enabled SubDets.

Definition at line 102 of file HLTResultMTMaker.h.

m_extraROBs

Gaudi::Property<std::vector<uint32_t> > HLTResultMTMaker::m_extraROBs

private

Initial value:

{
    this, "ExtraROBs", {},
    "Same as ExtraEnabledROBs but checked against detector mask and dropped if SubDet is masked out"
  }

Extra enabled ROBs checked against detector mask.

Definition at line 97 of file HLTResultMTMaker.h.

m_extraSubDets

Gaudi::Property<std::vector<uint32_t> > HLTResultMTMaker::m_extraSubDets

private

Initial value:

{
    this, "ExtraSubDets", {},
    "Same as ExtraEnabledSubDets but checked against detector mask and dropped if SubDet is masked out"
  }

Extra enabled SubDets checked against detector mask.

Definition at line 107 of file HLTResultMTMaker.h.

m_hltResultWHKey

SG::WriteHandleKey<HLT::HLTResultMT> HLTResultMTMaker::m_hltResultWHKey

private

Initial value:

{
    this, "HLTResultWHKey", "HLTResultMT",
    "Key of the output HLTResultMT object"
  }

StoreGate key for the HLTResultMT.

Definition at line 58 of file HLTResultMTMaker.h.

m_jobOptionsSvc

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> HLTResultMTMaker::m_jobOptionsSvc

private

Initial value:

{
    this, "JobOptionsSvc", "JobOptionsSvc",
    "Job options service to retrieve DataFlowConfig"
  }

Handle to JobOptionsSvc used to retrieve the DataFlowConfig property.

Definition at line 87 of file HLTResultMTMaker.h.

m_makerTools

ToolHandleArray<HLTResultMTMakerTool> HLTResultMTMaker::m_makerTools

private

Initial value:

{
    this, "MakerTools", {},
    "Set of additional tools that fill content of the HLTResultMT"
  }

Tools filling the HLTResultMT object.

Definition at line 77 of file HLTResultMTMaker.h.

m_monTool

ToolHandle<GenericMonitoringTool> HLTResultMTMaker::m_monTool

private

Initial value:

{
    this, "MonTool", "",
    "Monitoring tool"
  }

Monitoring tool.

Definition at line 82 of file HLTResultMTMaker.h.

m_runtimeMetadataWHKey

SG::WriteHandleKey<xAOD::TrigCompositeContainer> HLTResultMTMaker::m_runtimeMetadataWHKey

private

Initial value:

{ 
    this, "HLTRuntimeMetadataWHKey", "HLT_RuntimeMetadata",
    "Key of the output with additional runtime metadata" }

StoreGate key for HLT Runtime Metadata container.

Definition at line 63 of file HLTResultMTMaker.h.

m_skipValidatePEBInfo

bool HLTResultMTMaker::m_skipValidatePEBInfo {false}

private

If true, don't call validatePEBInfo.

Definition at line 118 of file HLTResultMTMaker.h.

m_streamTagMaker

ToolHandle<HLTResultMTMakerTool> HLTResultMTMaker::m_streamTagMaker

private

Initial value:

{
    this, "StreamTagMaker", "",
    "Tool creating stream tags (defines if event is accepted)"
  }

Tool creating stream tags (defines if event is accepted)

Definition at line 72 of file HLTResultMTMaker.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:

• HLTResultMTMaker.h
• HLTResultMTMaker.cxx