Test Algorithm for checking TagInfoMgr and the storing of geometry and conditions tags in EventInfo, writes extra tags. More...

#include <EventInfoWriter.h>

Inheritance diagram for EventInfoWriter:

Collaboration diagram for EventInfoWriter:

Public Types
using	Writer_t = H5Utils::Writer<0, const xAOD::EventInfo&>

Public Member Functions
	EventInfoWriter (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor.
virtual StatusCode	initialize () override
	Algorithm initialize at begin of job.
virtual StatusCode	execute () override
	Algorithm execute once per event.
virtual StatusCode	finalize () override
	Algorithm finalize at end of job.
	EventInfoWriter (H5::Group &output_group, const EventInfoWriterConfig &)
	~EventInfoWriter ()
void	fill (const xAOD::EventInfo &)
void	flush ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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 ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	EventInfoWriter ()
	Avoid use of default constructor.
	EventInfoWriter (const EventInfoWriter &)
	Avoid use of copy constructor.
EventInfoWriter &	operator= (const EventInfoWriter &)
	Avoid use of copy operator.
StatusCode	fillTagInfo ()
	Add in tags to TagInfoMgr.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
BooleanProperty	m_createDummyTags {this, "CreateDummyTags", false}
	For testing only: add in dummy tags.
BooleanProperty	m_removeDummyTags {this, "RemoveDummyTags", false}
	For testing only: remove input dummy tags.
BooleanProperty	m_createDummyOverrideTags {this, "CreateDummyOverrideTags", false}
	For testing only: add in dummy tags which may override existing tags.
ServiceHandle< ITagInfoMgr >	m_tagInfoMgr {this, "TagInfoMgr", "TagInfoMgr"}
	Access to the TagInfoMgr.
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfo", "EventInfo", "EventInfo name"}
	SG key for Event Info.
bool	m_setDummyTags = false
std::unique_ptr< Writer_t >	m_writer
DataObjIDColl	m_extendedExtraObjects
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

Test Algorithm for checking TagInfoMgr and the storing of geometry and conditions tags in EventInfo, writes extra tags.

Definition at line 38 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ Writer_t

using EventInfoWriter::Writer_t = H5Utils::Writer<0, const xAOD::EventInfo&>

Definition at line 23 of file PhysicsAnalysis/JetTagging/JetH5Writer/JetH5Writer/EventInfoWriter.h.

Constructor & Destructor Documentation

◆ EventInfoWriter() [1/4]

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

Algorithm constructor.

Definition at line 22 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.cxx.

                                           :
        AthAlgorithm(name,pSvcLocator)
{
}

◆ EventInfoWriter() [2/4]

EventInfoWriter::EventInfoWriter ( )

private

Avoid use of default constructor.

◆ EventInfoWriter() [3/4]

EventInfoWriter::EventInfoWriter ( const EventInfoWriter & )

private

Avoid use of copy constructor.

◆ EventInfoWriter() [4/4]

EventInfoWriter::EventInfoWriter	(	H5::Group &	output_group,
		const EventInfoWriterConfig &	cfg )

Definition at line 12 of file PhysicsAnalysis/JetTagging/JetH5Writer/src/EventInfoWriter.cxx.

{
  Writer_t::consumer_type c;
  for (const auto& input: cfg.inputs) {
    detail::addInput(c, input);
  }
  m_writer = std::make_unique<Writer_t>(group, cfg.name, c);
}

◆ ~EventInfoWriter()

EventInfoWriter::~EventInfoWriter ( )

default

Member Function Documentation

◆ declareGaudiProperty()

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

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode EventInfoWriter::execute ( )

overridevirtual

Algorithm execute once per event.

Definition at line 64 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.cxx.

{
    // Get the messaging service, print where you are
    ATH_MSG_DEBUG("EventInfoWriter::execute()");
 
    SG::ReadHandle<xAOD::EventInfo> eventInfo (m_eventInfoKey, getContext());
    if(!eventInfo.isValid()) {
    ATH_MSG_ERROR("  Could not get event info");      
    return StatusCode::FAILURE;
    }
    else {
    ATH_MSG_DEBUG("Event ID: ["
              << eventInfo->runNumber()   << ","
              << eventInfo->eventNumber() << ":"
              << eventInfo->timeStamp() << "] "
              );
    }
 
    // Set new dummy tags only at the first event of run 2
    if (!m_setDummyTags && eventInfo->runNumber() == 2 && m_createDummyOverrideTags) {
        m_setDummyTags = true;
        ATH_MSG_DEBUG("Create dummy tags, A2-D2");
    // New/different tags
        if (m_tagInfoMgr->addTag("TagA1", "A2").isFailure()) {
            ATH_MSG_WARNING("TagA1 NOT added");
        } 
        if (m_tagInfoMgr->addTag("TagB1", "B2").isFailure()) {
            ATH_MSG_WARNING("TagB1 NOT added");
    } 
        if (m_tagInfoMgr->addTag("TagC1", "C2").isFailure()) {
            ATH_MSG_WARNING("TagC1 NOT added");
    } 
        if (m_tagInfoMgr->addTag("TagD1", "D2").isFailure()) {
            ATH_MSG_WARNING("TagD1 NOT added");
    } 
    }
 
    // Dump out Tags
    ATH_MSG_DEBUG("Tags from TagInfoMgr:");
    MsgStream log(msgSvc(), name());
    m_tagInfoMgr->printTags(log);
    
    // Print out current Release version 
    std::string releaseVersion = m_tagInfoMgr->findTag("AtlasRelease");
    ATH_MSG_DEBUG("Found Release version from TagInfoMgr: " << releaseVersion);
 
    return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.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 Algorithm::extraOutputDeps();
}

◆ fill()

void EventInfoWriter::fill ( const xAOD::EventInfo & info )

Definition at line 25 of file PhysicsAnalysis/JetTagging/JetH5Writer/src/EventInfoWriter.cxx.

                                                    {
  m_writer->fill(info);
}

◆ fillTagInfo()

StatusCode EventInfoWriter::fillTagInfo ( )

private

Add in tags to TagInfoMgr.

Definition at line 124 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.cxx.

{
 
    // Get the messaging service, print where you are
    ATH_MSG_DEBUG("EventInfoWriter::fillTagInfo()");
 
    //
    //  For tests, add in dummy tags
    //
    if(m_createDummyTags) {
    ATH_MSG_DEBUG("Create dummy tags, A1-D1");
    // New/different tags
        if (m_tagInfoMgr->addTag("TagA1", "A1").isFailure()) {
        ATH_MSG_WARNING("TagA1 NOT added");
        } 
        if (m_tagInfoMgr->addTag("TagB1", "B1").isFailure()) {
        ATH_MSG_WARNING("TagB1 NOT added");
    } 
        if (m_tagInfoMgr->addTag("TagC1", "C1").isFailure()) {
        ATH_MSG_WARNING("TagC1 NOT added");
    } 
        if (m_tagInfoMgr->addTag("TagD1", "D1").isFailure()) {
        ATH_MSG_WARNING("TagD1 NOT added");
    } 
    }
 
    // Remove incoming dummy tag
    if (m_removeDummyTags) {
    ATH_MSG_DEBUG("Create dummy tags, A1-D1");
        if (m_tagInfoMgr->removeTagFromInput("TagC1").isFailure()) {
        ATH_MSG_WARNING("TagC1 NOT removed");
    } 
    }
        
    return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode EventInfoWriter::finalize ( )

overridevirtual

Algorithm finalize at end of job.

Definition at line 115 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.cxx.

{
    // Get the messaging service, print where you are
    ATH_MSG_DEBUG("EventInfoWriter::finalize()");
 
    return StatusCode::SUCCESS;
}

◆ flush()

void EventInfoWriter::flush ( )

Definition at line 29 of file PhysicsAnalysis/JetTagging/JetH5Writer/src/EventInfoWriter.cxx.

                            {
  m_writer->flush();
}

◆ initialize()

StatusCode EventInfoWriter::initialize ( )

overridevirtual

Algorithm initialize at begin of job.

Definition at line 29 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.cxx.

{
    // Get the messaging service, print where you are
    ATH_MSG_DEBUG("EventInfoWriter::initialize()");
 
    ATH_MSG_DEBUG("CreateDummyTags         " << m_createDummyTags);
    ATH_MSG_DEBUG("RemoveDummyTags         " << m_removeDummyTags);
    ATH_MSG_DEBUG("CreateDummyOverrideTags " << m_createDummyOverrideTags);
 
    // get TagInfoMgr service
    ATH_CHECK(m_tagInfoMgr.retrieve());
 
    // Insert a dummy tag into the TagInfoMgr
    if (m_tagInfoMgr->addTag("EventInfoWriterTag", "EIW-00-00-01").isFailure()) {
    ATH_MSG_FATAL("Unable to add tag to TagInfoMgr !");
    return StatusCode::FAILURE;
    } 
    else {
    ATH_MSG_DEBUG("Added tag to TagInfoMgr");
    }
 
    if (fillTagInfo().isFailure()) {
    ATH_MSG_FATAL("Unable to to call fillTagInfo !");
    return StatusCode::FAILURE;
    } 
    else {
    ATH_MSG_DEBUG("Called fillTagInfo");
    }
 
    ATH_CHECK (m_eventInfoKey.initialize());
 
    return StatusCode::SUCCESS;
}

◆ inputHandles()

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

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ operator=()

EventInfoWriter & EventInfoWriter::operator= ( const EventInfoWriter & )

private

Avoid use of copy operator.

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::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< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::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< 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< 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_createDummyOverrideTags

BooleanProperty EventInfoWriter::m_createDummyOverrideTags {this, "CreateDummyOverrideTags", false}

private

For testing only: add in dummy tags which may override existing tags.

Definition at line 84 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

84{this, "CreateDummyOverrideTags", false};

◆ m_createDummyTags

BooleanProperty EventInfoWriter::m_createDummyTags {this, "CreateDummyTags", false}

private

For testing only: add in dummy tags.

Definition at line 77 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

77{this, "CreateDummyTags", false};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> EventInfoWriter::m_eventInfoKey {this, "EventInfo", "EventInfo", "EventInfo name"}

private

SG key for Event Info.

Definition at line 90 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

90{this, "EventInfo", "EventInfo", "EventInfo name"};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_removeDummyTags

BooleanProperty EventInfoWriter::m_removeDummyTags {this, "RemoveDummyTags", false}

private

For testing only: remove input dummy tags.

Definition at line 80 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

80{this, "RemoveDummyTags", false};

◆ m_setDummyTags

bool EventInfoWriter::m_setDummyTags = false

private

Definition at line 92 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

◆ m_tagInfoMgr

ServiceHandle<ITagInfoMgr> EventInfoWriter::m_tagInfoMgr {this, "TagInfoMgr", "TagInfoMgr"}

private

Access to the TagInfoMgr.

Definition at line 87 of file AtlasTest/DatabaseTest/AthenaPoolTest/src/EventInfoWriter.h.

87{this, "TagInfoMgr", "TagInfoMgr"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writer

std::unique_ptr<Writer_t> EventInfoWriter::m_writer

private

Definition at line 29 of file PhysicsAnalysis/JetTagging/JetH5Writer/JetH5Writer/EventInfoWriter.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

◆ Writer_t

Constructor & Destructor Documentation

◆ EventInfoWriter() [1/4]

◆ EventInfoWriter() [2/4]

◆ EventInfoWriter() [3/4]

◆ EventInfoWriter() [4/4]

◆ ~EventInfoWriter()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fill()

◆ fillTagInfo()

◆ finalize()

◆ flush()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ operator=()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_createDummyOverrideTags

◆ m_createDummyTags

◆ m_detStore

◆ m_eventInfoKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_removeDummyTags

◆ m_setDummyTags

◆ m_tagInfoMgr

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writer