#include <ReadData.h>

Inheritance diagram for ReadData:

Collaboration diagram for ReadData:

Public Member Functions
	ReadData (const std::string &name, ISvcLocator *pSvcLocator)

StatusCode	initialize ()

StatusCode	execute ()

StatusCode	finalize ()

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. 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	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
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
std::string	m_DataProducer

SG::ReadHandle< MyDataObj >	m_dobj3

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EvtInfo", "EventInfo", "EventInfo name"}

DataObjIDColl	m_extendedExtraObjects

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

Definition at line 20 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ReadData()

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

Definition at line 26 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.cxx.

                                                                   :
   AthAlgorithm(name, pSvcLocator)
 {
   
   // Declare the properties
   declareProperty("DataProducer", m_DataProducer);
  
 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode ReadData::execute ( )

Definition at line 59 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.cxx.

                              {
  
   // An algorithm, like this one, retrieving an object from the StoreGate(SG)
   // can either ask for:
   //    i) the most recent (default) object of a given type 
   //   ii) a specific object of a given type
   //  iii) all objects of a given type
   //This example will show how to perform these three tasks
  
  
   ATH_MSG_INFO ("in execute()");
  
   // Part 1: retrieving individual objects from SG
   //
   //   i)Get the most recent (default) object of type MyDataObj
   // we start by creating a *const* pointer: we won't be able
   // to modify the MyDataObj we retrieve.
   //unless you know what you are doing, *always* use const pointers 
    //FIXME const MyDataObj* dobj;
  
   //We pass the pointer to the StoreGate that will set it to point to
   //the default MyDataObj. More precisely the handle will now contain
   //all infos necessary to access (or create) the default MyDataObj when 
   //we will use it 
   //FIXME new (tag StoreGate-02-12-08) keyless record scheme does not allow it!
   //FIXME  if (StatusCode::SUCCESS != p_SGevent->retrieve(dobj) ) {
   //FIXME    log << MSG::ERROR 
   //FIXME   << "Could not find default MyDataObj" 
   //FIXME   << endmsg;
   //FIXME    return( StatusCode::FAILURE);
   //FIXME  }
   //FIXME  log << MSG::INFO 
   //FIXME      << "default MyDataObj Val: " << dobj->val() 
   //FIXME      << endmsg;
  
   //   ii) Get a specific MyDataObj by providing its key 
   //       (in this case the name of the algo which recorded it)
  
   ATH_MSG_INFO ("Get the MyDataObj recorded by " << m_DataProducer);
  
   //this time we set a *non-const* pointer. *If* we get back a valid
   //pointer we'll be able to modify the content of the underlying transient obj
   MyDataObj* dobj3;
   //Most objects recorded to the SG may not be retrieved
   //using a non-const handle, unless the original producer of the object 
   //allowed for later modifications invoking StoreGateSvc::record with 
   //the last "allowMods" optional argument = true 
  
   //  We retrieve our MyDataObj, using m_DataProducer as our key
   if (StatusCode::SUCCESS != evtStore()->retrieve(dobj3, m_DataProducer)) {
     ATH_MSG_ERROR ("Could not find MyDataObj " << m_DataProducer);
     return (StatusCode::FAILURE);
   } else {
     dobj3->val(4);   // should be able to do this
   }
  
   // Also check retrieving it as a const object via ReadHandle.
   assert (m_dobj3->val() == 4);
  
   //not every type can be used as a key.
   //These requirements are checked at compile time in the record method
   //using StoreGate/constraints/KeyConcept.h
   //uncomment to see how the key concept is checked by the compiler
   //  p_SGevent->retrieve(dobj3, 1.0);
   //concept checking does not work using egcs 1.1 (gcc 2.91)
   //(but you still get a compiler error message...)
  
   // iii) Get all recorded instances of MyDataObj, print out their contents
  
   // (a SG::ConstIterator is an iterator class that we also use to defer
   //  and control the access to the persistent object)
   SG::ConstIterator<MyDataObj> iMyD;
   SG::ConstIterator<MyDataObj> eMyD;
  
   if (StatusCode::SUCCESS != evtStore()->retrieve(iMyD, eMyD) ) {
     ATH_MSG_ERROR ("Could not find MyDataObj list");
     return( StatusCode::FAILURE);
   }
  
   // while(iMyD != eMyD) {
   //   ATH_MSG_INFO ((*iMyD).val());
   //   ++iMyD;
   // }
   ATH_MSG_WARNING ("FIXME loop of ConstIterator bombs");
  
  
  
 // Get the default listof MyContObj, print out its contents
  
   //the CLID of list<MyContObj> must be defined using the CLASSDEF
   //macros. See StoreGateExample_ClassDEF.h for a few examples
   //If no CLID is defined StoreGate assumes the object is (convertible to a)
   //DataObject. If this is not the case an error message is issued:
   //uncomment below to see how your compiler catches an undefined CLID
   //ERROR  p_SGevent->retrieve(errorH);
  
   DataVector<MyContObj>::const_iterator it;
  
   //now let's try again with a const pointer
   const DataVector<MyContObj>* list;
  
   if (StatusCode::SUCCESS != evtStore()->retrieve(list) ) {
     ATH_MSG_ERROR ("Could not find list of MyContObj");
     return( StatusCode::FAILURE);
   } else {
     ATH_MSG_INFO ("Retrieved DataVector of MyContObj using a const pointer");
   }
   for (const MyContObj* obj : *list) {
     float time = obj->time();
     int ID     = obj->id();
     
     ATH_MSG_INFO ("Time: " << time << "  ID: " << ID);
   }
  
  
 // Get the std::vector, print out its contents
  
   const std::vector<float>* pVec;
  
   if (StatusCode::SUCCESS != evtStore()->retrieve(pVec) ) {
     ATH_MSG_ERROR ("Could not find vector<int>");
     return( StatusCode::FAILURE);
   }
  
   for (unsigned int it=0; it<pVec->size(); it++) {
     ATH_MSG_INFO ("pVec [" << it << "] = " << (*pVec)[it]);
   }
  
   // test if an object is in the store
   //FIXME if (p_SGevent->contains<MyDataObj>(SG::DEFAULTKEY)) {
   //FIXME     log << MSG::INFO
   //FIXME   <<"event store contains default MyDataObj"
   //FIXME   <<endmsg;
   //FIXME   } else {
   //FIXME     log << MSG::ERROR
   //FIXME   <<"event store claims it does not contain default MyDataObj"
   //FIXME       <<endmsg;
   //FIXME     return( StatusCode::FAILURE);
   //FIXME   }   
  
   // test if an object is not in the store
   if (evtStore()->contains<MyDataObj>("FunnyNonExistingKey")) {
     ATH_MSG_ERROR 
       ("event store claims it contains MyDataObj with FunnyNonExistingKey");
     return( StatusCode::FAILURE);
   } else {
     ATH_MSG_INFO
       ("event store does not contain MyDataObj with FunnyNonExistingKey");
   } 
  
   
   
   // Part 2: retrieving DataLinks
  
   // Get the list of links, print out its contents
   
   typedef ElementLink<std::vector<float> > VecElemLink;
   const std::list<VecElemLink>* pList = nullptr;
  
   if (!(evtStore()->retrieve(pList)).isSuccess() ) {
     ATH_MSG_ERROR ("Could not find list of links");
     return( StatusCode::FAILURE);
   } else
     ATH_MSG_INFO ("Retrieved list of links");
  
   std::list<VecElemLink>::const_iterator itL= pList->begin();
   std::list<VecElemLink>::const_iterator endL= pList->end();
  
   while(itL != endL) {
     ATH_MSG_INFO ("ListVecLinks::linked element " << **itL);
     ++itL;
   }
  
 // Get the vector of links, print out its contents
  
   typedef ElementLink<MapStringFloat> MapElemLink;
   const std::vector<MapElemLink>* vectorHandle;
  
   if (StatusCode::SUCCESS != evtStore()->retrieve(vectorHandle) ) {
     ATH_MSG_ERROR ("Could not find vector of links");
     return( StatusCode::FAILURE);
   } else
     ATH_MSG_INFO ("Retrieved vector of links");
  
   std::vector<MapElemLink>::const_iterator itV= vectorHandle->begin();
   std::vector<MapElemLink>::const_iterator endV= vectorHandle->end();
   while(itV != endV) {
     ATH_MSG_INFO 
       ("VectorMapLinks::linked element: key " << itV->index()
        << " - value " << (**itV) 
        << " - stored as " << *itV);
     ++itV;
   }
  
   //try to "read back" a link
   //    istrstream istr("due 0");
   //    MapElemLink toBeRead;
   //    istr >> toBeRead;
   //    if (!toBeRead.isValid()) {
   //      log << MSG::ERROR 
   //    << "Could not read back MapElement" 
   //    << endmsg;
   //      return( StatusCode::FAILURE);
   //    } else {
   //      log << MSG::INFO <<  "MapElement read back: key " << toBeRead->first
   //    << "  value " << toBeRead->second <<endmsg;
   //    }
  
   // Part 3: symbolic links and derived types
   // Get all objects as its base class 
  
   SG::ConstIterator<BaseClass> it2;
   SG::ConstIterator<BaseClass> iEnd2;
  
   if (StatusCode::SUCCESS != evtStore()->retrieve(it2, iEnd2) ) {
  
     ATH_MSG_ERROR ("Could not find base class list");
     return( StatusCode::FAILURE);
   }
  
   // not much we can do with an empty base class,
   // so print the path of its persistable companion (the DataBucket)
   ATH_MSG_INFO (" retrieve as BaseClass, print its address: ");
   while(it2 != iEnd2) {
     ATH_MSG_INFO (&*it2);
     ++it2;
   }
   
   // Part 4: Get the event header, print out event and run number
  
   SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo);
   if(eventInfo.isValid()) {
     int event = eventInfo->eventNumber();
     int run = eventInfo->runNumber();
     ATH_MSG_INFO (" EventInfo : " 
           << " event: " << event 
           << " run: " << run);
   }
   else
   {
     ATH_MSG_ERROR (" Unable to retrieve EventInfo from StoreGate ");
     return StatusCode::SUCCESS;
   }
  
   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();
 }

◆ finalize()

StatusCode ReadData::finalize ( )

Definition at line 317 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.cxx.

                               {
  
   ATH_MSG_INFO ("in finalize()");
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode ReadData::initialize ( )

Definition at line 37 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.cxx.

                                {
  
  
   ATH_MSG_INFO ("in initialize()");
  
   // Print out the location of the data objects
   ATH_MSG_INFO ("Data Object producer: " << m_DataProducer);
  
   //locate the StoreGateSvc and initialize our local ptr
   StatusCode sc = evtStore().retrieve();
   if (!sc.isSuccess()) 
     ATH_MSG_ERROR ("Could not find StoreGateSvc");
  
   ATH_CHECK( m_dobj3.assign (m_DataProducer) );
   ATH_CHECK( m_dobj3.initialize() );
   
   ATH_CHECK( m_eventInfo.initialize() );
   return sc;
 }

◆ 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() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< 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< 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, PyAthena::Alg, and AthHistogramAlgorithm.

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_DataProducer

std::string ReadData::m_DataProducer

private

Definition at line 29 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.h.

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

SG::ReadHandle<MyDataObj> ReadData::m_dobj3

private

Definition at line 30 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.h.

◆ m_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> ReadData::m_eventInfo {this, "EvtInfo", "EventInfo", "EventInfo name"}

private

Definition at line 31 of file Control/AthenaExamples/AthExStoreGateExample/src/ReadData.h.

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

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

Constructor & Destructor Documentation

◆ ReadData()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_DataProducer

◆ m_detStore

◆ m_dobj3

◆ m_eventInfo

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_varHandleArraysDeclared

◆ m_vhka