The RoIROD Athena Algorithm takes the output from the LVL1 Calo Trigger simulations and produces the words, as would be produced by the hardware ReadOut Drivers (RODs); i.e. More...

#include <RoIROD.h>

Inheritance diagram for LVL1::RoIROD:

Collaboration diagram for LVL1::RoIROD:

Public Member Functions
	RoIROD (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~RoIROD ()
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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

Private Types
typedef DataVector< LVL1::CPMTobRoI >	t_cpmTobRoIContainer
typedef DataVector< LVL1::JEMTobRoI >	t_jemTobRoIContainer
typedef CMXRoI	t_EnergyRoIContainer
typedef DataVector< LVL1CTP::SlinkWord >	t_SlinkContainer
typedef std::unique_ptr< t_SlinkContainer >	t_SlinkPtr
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	addHeader (t_SlinkContainer &slink, unsigned int subDetID, unsigned int moduleId, const EventContext &ctx) const
	adds slink header
void	addTail (t_SlinkContainer &slink, unsigned int numberOfDataWords) const
	add Slink tail
StatusCode	saveSlinkObjects (t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs], t_SlinkPtr jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs], const EventContext &ctx) const
	save Slink Objects to SG
void	formSlinkObjects (t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs], t_SlinkPtr jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs], const EventContext &ctx) const
	get ROIwords and form Slink words from them, adding header and tail.
void	assignVectors (t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs], t_SlinkPtr jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs]) const
	Create the object vectors to be stored in SG and clear mult vectors.
std::unique_ptr< LVL1CTP::SlinkWord >	getWord (unsigned int tword) const
	creates a new SlinkWord object with the passed word, and returns a pointer.
void	dumpSlinks (t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs]) const
	prints out the Slink info.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< t_cpmTobRoIContainer >	m_emTauRoILocation { this, "EmTauRoILocation", TrigT1CaloDefs::CPMTobRoILocation, "" }
SG::ReadHandleKey< t_jemTobRoIContainer >	m_JetRoILocation { this, "JetRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "" }
SG::ReadHandleKey< t_EnergyRoIContainer >	m_energyRoILocation { this, "EnergyRoILocation", TrigT1CaloDefs::CMXRoILocation, "" }
std::string	m_emTauSlinkLocation
SG::WriteHandleKeyArray< t_SlinkContainer >	m_emTauSlinkKeys { this, "EmTauSlinkKeys", {}, "" }
std::string	m_jepSlinkLocation
SG::WriteHandleKeyArray< t_SlinkContainer >	m_jepSlinkKeys { this, "JEPSlinkKeys", {}, "" }
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

The RoIROD Athena Algorithm takes the output from the LVL1 Calo Trigger simulations and produces the words, as would be produced by the hardware ReadOut Drivers (RODs); i.e.

-Cluster (Em & Tau) ROD to RoIB
-Jet/Energy ROD to RoIB

Definition at line 48 of file RoIROD.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ t_cpmTobRoIContainer

typedef DataVector<LVL1::CPMTobRoI> LVL1::RoIROD::t_cpmTobRoIContainer

private

Definition at line 50 of file RoIROD.h.

◆ t_EnergyRoIContainer

typedef CMXRoI LVL1::RoIROD::t_EnergyRoIContainer

private

Definition at line 52 of file RoIROD.h.

◆ t_jemTobRoIContainer

typedef DataVector<LVL1::JEMTobRoI> LVL1::RoIROD::t_jemTobRoIContainer

private

Definition at line 51 of file RoIROD.h.

◆ t_SlinkContainer

typedef DataVector<LVL1CTP::SlinkWord> LVL1::RoIROD::t_SlinkContainer

private

Definition at line 53 of file RoIROD.h.

◆ t_SlinkPtr

typedef std::unique_ptr<t_SlinkContainer> LVL1::RoIROD::t_SlinkPtr

private

Definition at line 54 of file RoIROD.h.

Constructor & Destructor Documentation

◆ RoIROD()

LVL1::RoIROD::RoIROD	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 24 of file RoIROD.cxx.

    : AthReentrantAlgorithm( name, pSvcLocator ),
    m_emTauSlinkLocation(TrigT1CaloDefs::EmTauSlinkLocation),
    m_jepSlinkLocation(TrigT1CaloDefs::jepSlinkLocation)
{
 
  declareProperty(  "EmTauSlinkLocation",   m_emTauSlinkLocation );
  declareProperty(  "JEPSlinkLocation",     m_jepSlinkLocation );
}

◆ ~RoIROD()

LVL1::RoIROD::~RoIROD ( )

virtual

Definition at line 36 of file RoIROD.cxx.

36 {

37}

Member Function Documentation

◆ addHeader()

void LVL1::RoIROD::addHeader	(	t_SlinkContainer &	slink,
		unsigned int	subDetID,
		unsigned int	moduleId,
		const EventContext &	ctx ) const

private

adds slink header

adds slink header as defined in DAQ-98-129

Definition at line 163 of file RoIROD.cxx.

{
  slink.push_back(getWord(0xb0f00000));      // beginning of fragment word (control word)
  slink.push_back(getWord(0xee1234ee));       // start of header marker
  slink.push_back(getWord(8));                       // header length
  slink.push_back(getWord(1));                      // format version number
  unsigned int moduleType=0x00;  // ROD
  slink.push_back(getWord( (moduleType<<16)+(subDetID<<8)+moduleId ));  // 1st 8b but source id: CP system
  slink.push_back(getWord(ctx.eventID().event_number()));       // 8b ECR_count (set to 0) | 24b L1 id = evt number
  slink.push_back( getWord(1 ));                           // 8b BCID
  slink.push_back( getWord(1 ));                           // 8b L1 trig type
  slink.push_back( getWord(0 ));                           // detector evt type}
}

◆ addTail()

void LVL1::RoIROD::addTail	(	t_SlinkContainer &	slink,
		unsigned int	numberOfDataWords ) const

private

add Slink tail

Definition at line 181 of file RoIROD.cxx.

{
  slink.push_back(getWord(0 ));                           // write status word 1
  slink.push_back(getWord(0 ));                           // write status word 2
//^^^ not simulating any errors.
  slink.push_back(getWord(2 ));                           // status block length
  slink.push_back(getWord(numberOfDataWords));            // calculated data block length
  slink.push_back(getWord(1 ));                           // status block position
// ^^^ indicates that data precedes status block
  slink.push_back(getWord(0xe0f00000 ));                  // end of fragment word
}

◆ assignVectors()

void LVL1::RoIROD::assignVectors	(	t_SlinkPtr	CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs],
		t_SlinkPtr	jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs] ) const

private

Create the object vectors to be stored in SG and clear mult vectors.

Definition at line 214 of file RoIROD.cxx.

{
  ATH_MSG_DEBUG("assignVectors" );
 
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfCPRoIRODs;i++){
    CPRoIROD[i] = std::make_unique<t_SlinkContainer>();
  }
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfJEPRoIRODs;i++){
    jepRoIROD[i] = std::make_unique<t_SlinkContainer>();
  }
 
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ dumpSlinks()

void LVL1::RoIROD::dumpSlinks ( t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs] ) const

private

prints out the Slink info.

Definition at line 236 of file RoIROD.cxx.

{
  for (unsigned int slink=0; slink<(TrigT1CaloDefs::numOfCPRoIRODs);slink++){
    ATH_MSG_INFO("Slink cable  "<<slink
        <<" has "<<(CPRoIROD[slink]->size())<<" words");
    for (DataVector<LVL1CTP::SlinkWord>::iterator i=CPRoIROD[slink]->begin();
                                      i!=CPRoIROD[slink]->end();++i){
      ATH_MSG_INFO("Word :"<<MSG::hex<<(*i)->word()<<MSG::dec);
    }
  }
}

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LVL1::RoIROD::execute ( const EventContext & ctx ) const

overridevirtual

there are 4 CP RoI RODs which have a Slink cable connected to the RoIB. This array holds pointers to 4 DataVectors containing the Slink words

there are 2 Jet RoI RODs which have a Slink cable connected to the RoIB. This array holds pointers to 2 DataVectors containing the Slink words

Definition at line 82 of file RoIROD.cxx.

{
  ATH_MSG_DEBUG("Executing" );
  t_SlinkPtr CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs];
  t_SlinkPtr jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs];
  assignVectors (CPRoIROD, jepRoIROD);    // create new storage vectors 
  formSlinkObjects (CPRoIROD, jepRoIROD, ctx); // Fill storage vectors
  ATH_CHECK( saveSlinkObjects (CPRoIROD, jepRoIROD, ctx) ); // save storage vectors
 
  return StatusCode::SUCCESS ;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

◆ finalize()

StatusCode LVL1::RoIROD::finalize ( )

overridevirtual

Definition at line 70 of file RoIROD.cxx.

{
   ATH_MSG_INFO("Finalizing" );
   return StatusCode::SUCCESS ;
}

◆ formSlinkObjects()

void LVL1::RoIROD::formSlinkObjects	(	t_SlinkPtr	CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs],
		t_SlinkPtr	jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs],
		const EventContext &	ctx ) const

private

get ROIwords and form Slink words from them, adding header and tail.

Set SLink headers

Retrieve CPMTobRoIs and copy data to SLink vectors

Push TOBs to ROD vectors This version makes no attempt to order them.

Retrieve JEMTobRoIs and copy data to SLink vectors

Push TOBs to ROD vectors This version makes no attempt to order them.

Retrieve EnergySum RoI(s) and add to SLink record

Add 6 ET RoIWords to crate 1 ROD data.

Set SLink tails

Definition at line 101 of file RoIROD.cxx.

{
  ATH_MSG_DEBUG("formSlinkObjects" );
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfCPRoIRODs;i++){
    addHeader(*CPRoIROD[i],0x72,i, ctx);//set modID to crate #
  }
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfJEPRoIRODs;i++){
    addHeader(*jepRoIROD[i],0x73,i, ctx);//set modID to crate #
  }
  
  
  ATH_MSG_DEBUG("Load and process CPM TOBs");
  SG::ReadHandle<t_cpmTobRoIContainer> EMTaus (m_emTauRoILocation, ctx);
  for (const CPMTobRoI* tau : *EMTaus) {
    int crate = tau->crate();
    CPRoIROD[crate]->push_back( getWord(tau->roiWord()) );
  }
  
  
  ATH_MSG_DEBUG("Load and process Jet TOBs");
  SG::ReadHandle<t_jemTobRoIContainer> Jets (m_JetRoILocation, ctx);
  for (const JEMTobRoI* jet : *Jets) {
    int crate = jet->crate();
    jepRoIROD[crate]->push_back( getWord(jet->roiWord()) );
  }
  
  
  SG::ReadHandle<t_EnergyRoIContainer> energy (m_energyRoILocation, ctx);
  jepRoIROD[1]->push_back(getWord(energy->exWord(LVL1::CMXRoI::NORMAL)));
  jepRoIROD[1]->push_back(getWord(energy->eyWord(LVL1::CMXRoI::NORMAL)));
  jepRoIROD[1]->push_back(getWord(energy->etWord(LVL1::CMXRoI::NORMAL)));
  jepRoIROD[1]->push_back(getWord(energy->exWord(LVL1::CMXRoI::MASKED)));
  jepRoIROD[1]->push_back(getWord(energy->eyWord(LVL1::CMXRoI::MASKED)));
  jepRoIROD[1]->push_back(getWord(energy->etWord(LVL1::CMXRoI::MASKED)));
  
  
  const unsigned int headerWords=8+1;//8 in Slink head + control word
  
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfCPRoIRODs;i++){
    addTail(*CPRoIROD[i], (CPRoIROD[i]->size()-headerWords) );
  }
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfJEPRoIRODs;i++){
    addTail(*jepRoIROD[i], (jepRoIROD[i]->size()-headerWords) );
  }
 
  return;
}

◆ getWord()

std::unique_ptr< LVL1CTP::SlinkWord > LVL1::RoIROD::getWord ( unsigned int tword ) const

private

creates a new SlinkWord object with the passed word, and returns a pointer.

Definition at line 229 of file RoIROD.cxx.

{
  return std::make_unique<LVL1CTP::SlinkWord>(tword);
}

◆ initialize()

StatusCode LVL1::RoIROD::initialize ( )

overridevirtual

Definition at line 44 of file RoIROD.cxx.

{
  ATH_CHECK( m_emTauRoILocation.initialize() );
  ATH_CHECK( m_JetRoILocation.initialize() );
  ATH_CHECK( m_energyRoILocation.initialize() );
 
  m_jepSlinkKeys.clear();
  m_jepSlinkKeys.push_back (m_jepSlinkLocation + "0");
  m_jepSlinkKeys.push_back (m_jepSlinkLocation + "1");
  ATH_CHECK( m_jepSlinkKeys.initialize() );
 
  m_emTauSlinkKeys.clear();
  m_emTauSlinkKeys.push_back (m_emTauSlinkLocation + "0");
  m_emTauSlinkKeys.push_back (m_emTauSlinkLocation + "1");
  m_emTauSlinkKeys.push_back (m_emTauSlinkLocation + "2");
  m_emTauSlinkKeys.push_back (m_emTauSlinkLocation + "3");
  ATH_CHECK( m_emTauSlinkKeys.initialize() );
 
  return StatusCode::SUCCESS ;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ saveSlinkObjects()

StatusCode LVL1::RoIROD::saveSlinkObjects	(	t_SlinkPtr	CPRoIROD[TrigT1CaloDefs::numOfCPRoIRODs],
		t_SlinkPtr	jepRoIROD[TrigT1CaloDefs::numOfJEPRoIRODs],
		const EventContext &	ctx ) const

private

save Slink Objects to SG

Definition at line 195 of file RoIROD.cxx.

{
  ATH_MSG_DEBUG("saveSlinkObjects");
 
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfCPRoIRODs;++i){
    ATH_CHECK( SG::makeHandle (m_emTauSlinkKeys[i], ctx).record (std::move(CPRoIROD[i])) );
  }
 
  for (unsigned int i = 0; i<TrigT1CaloDefs::numOfJEPRoIRODs;++i){
    ATH_CHECK( SG::makeHandle (m_jepSlinkKeys[i], ctx).record (std::move(jepRoIROD[i])) );
  }
  
  return StatusCode::SUCCESS;
}

◆ setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

◆ sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_emTauRoILocation

SG::ReadHandleKey<t_cpmTobRoIContainer> LVL1::RoIROD::m_emTauRoILocation { this, "EmTauRoILocation", TrigT1CaloDefs::CPMTobRoILocation, "" }

private

Definition at line 98 of file RoIROD.h.

99{ this, "EmTauRoILocation", TrigT1CaloDefs::CPMTobRoILocation, "" };

LVL1::TrigT1CaloDefs::CPMTobRoILocation

static const std::string CPMTobRoILocation

Definition TrigT1CaloDefs.h:62

◆ m_emTauSlinkKeys

SG::WriteHandleKeyArray<t_SlinkContainer> LVL1::RoIROD::m_emTauSlinkKeys { this, "EmTauSlinkKeys", {}, "" }

private

Definition at line 106 of file RoIROD.h.

107{ this, "EmTauSlinkKeys", {}, "" };

◆ m_emTauSlinkLocation

std::string LVL1::RoIROD::m_emTauSlinkLocation

private

Definition at line 105 of file RoIROD.h.

◆ m_energyRoILocation

SG::ReadHandleKey<t_EnergyRoIContainer> LVL1::RoIROD::m_energyRoILocation { this, "EnergyRoILocation", TrigT1CaloDefs::CMXRoILocation, "" }

private

Definition at line 102 of file RoIROD.h.

103{ this, "EnergyRoILocation", TrigT1CaloDefs::CMXRoILocation, "" };

LVL1::TrigT1CaloDefs::CMXRoILocation

static const std::string CMXRoILocation

Definition TrigT1CaloDefs.h:60

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_jepSlinkKeys

SG::WriteHandleKeyArray<t_SlinkContainer> LVL1::RoIROD::m_jepSlinkKeys { this, "JEPSlinkKeys", {}, "" }

private

Definition at line 110 of file RoIROD.h.

111{ this, "JEPSlinkKeys", {}, "" };

◆ m_jepSlinkLocation

std::string LVL1::RoIROD::m_jepSlinkLocation

private

Definition at line 109 of file RoIROD.h.

◆ m_JetRoILocation

SG::ReadHandleKey<t_jemTobRoIContainer> LVL1::RoIROD::m_JetRoILocation { this, "JetRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "" }

private

Definition at line 100 of file RoIROD.h.

101{ this, "JetRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "" };

LVL1::TrigT1CaloDefs::JEMTobRoILocation

static const std::string JEMTobRoILocation

Definition TrigT1CaloDefs.h:64

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

◆ t_cpmTobRoIContainer

◆ t_EnergyRoIContainer

◆ t_jemTobRoIContainer

◆ t_SlinkContainer

◆ t_SlinkPtr

Constructor & Destructor Documentation

◆ RoIROD()

◆ ~RoIROD()

Member Function Documentation

◆ addHeader()

◆ addTail()

◆ assignVectors()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ dumpSlinks()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ formSlinkObjects()

◆ getWord()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ saveSlinkObjects()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_emTauRoILocation

◆ m_emTauSlinkKeys

◆ m_emTauSlinkLocation

◆ m_energyRoILocation

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_jepSlinkKeys

◆ m_jepSlinkLocation

◆ m_JetRoILocation

◆ m_varHandleArraysDeclared

◆ m_vhka