SGInputLoader Class Reference

#include <SGInputLoader.h>

Inheritance diagram for SGInputLoader:

Collaboration diagram for SGInputLoader:

Public Member Functions
	SGInputLoader (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~SGInputLoader ()
bool	isClonable () const override
	this Alg is Clonable (for AthenaMT)
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) override
	Execute method.
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
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
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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
	SGInputLoader ()
	Default constructor:
void	loader (Gaudi::Details::PropertyBase &)
bool	loadObjs (const DataObjIDColl &objs) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
DataObjIDColl	m_load
	Properties.
Gaudi::Property< bool >	m_dump
Gaudi::Property< bool >	m_preLoad
Gaudi::Property< bool >	m_failEvt
Gaudi::Property< bool >	m_loadProxies
Gaudi::Property< std::string >	m_dataHeaderKey
bool	m_first {true}
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

Definition at line 20 of file SGInputLoader.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

SGInputLoader() [1/2]

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

Definition at line 44 of file SGInputLoader.cxx.

                                         : 
  ::AthAlgorithm( name, pSvcLocator )
{
  //
  // Property declaration
  // 
  declareProperty( "Load", m_load, "create Output data dependencies for these objects")
    ->declareUpdateHandler(&SGInputLoader::loader, this);
 
}

~SGInputLoader()

SGInputLoader::~SGInputLoader ( )

virtual

Definition at line 58 of file SGInputLoader.cxx.

{}

SGInputLoader() [2/2]

SGInputLoader::SGInputLoader ( )

private

Default constructor:

Member Function Documentation

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode SGInputLoader::execute ( const EventContext & ctx )

overridevirtual

Execute method.

Implements AthAlgorithm.

Definition at line 99 of file SGInputLoader.cxx.

{  
  StatusCode sc(StatusCode::SUCCESS);
 
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  // add objects automatically added by the Scheduler
  if (m_first) {
    if (m_loadProxies.value()) {
      for (DataObjID obj : outputDataObjs() ) {
        // Strip any decoration name.
        std::string::size_type ppos = obj.key().find ('.');
        if (ppos < obj.key().size()-1) {
          //obj.updateKey (obj.key().substr (0, ppos));
          // commented out line above, to keep decoration on key so can distinguish undeclared decorations from undeclared objects
          // undeclared objects will be an error, undeclared decorations will just be a warning
          // TODO: restore the above modification (and make all transient proxies an error in loadObj, not just non-decorations) when all decorations are declared
        }
        m_load.emplace (std::move(obj));
      }
    }
 
    // check if objects are not in EventStore
    DataObjIDColl toLoad;
    for (const DataObjID* obj : sortedDataObjIDColl (m_load)) {
      // don't load anything that is in the ExtraOutputs list, which is used for objects created e.g. by the eventloopmgr
      if( extraOutputDeps().count(*obj) ) {
        ATH_MSG_DEBUG(obj->key() << " is in ExtraOutputs and will not be loaded");
        continue;
      } else if(std::string::size_type ppos = obj->key().find ('.'); ppos < obj->key().size()-1) {
        // see if the object that the decoration is on is declared as extra output. Will assume the extra output
        // will also provide such a decoration
        DataObjID objcopy(*obj);
        objcopy.updateKey(obj->key().substr (0, ppos));
        if( extraOutputDeps().count(objcopy) ) {
          ATH_MSG_DEBUG(obj->key() << "'s object/container is in ExtraOutputs and will not be loaded");
          continue;
        }
      }
      SG::VarHandleKey vhk(obj->clid(),obj->key(),Gaudi::DataHandle::Writer);
      if (StoreID::findStoreID(vhk.storeHandle().name()) == StoreID::EVENT_STORE) {
        toLoad.emplace(*obj);
      }
      else if (StoreID::findStoreID(vhk.storeHandle().name()) == StoreID::CONDITION_STORE) {
        ATH_MSG_ERROR("Unresolved conditions dependency: "
                        << *obj);
        return StatusCode::FAILURE;
      }
      else {
        ATH_MSG_DEBUG("Will not auto-load proxy for non-EventStore object: "
                        << *obj);
      }
    }
    m_load = std::move(toLoad);
    
    m_first = false;
  }
 
  bool b = loadObjs( m_load );
 
  if (m_dump.value()) {
    ATH_MSG_DEBUG(evtStore()->dump());
  }
 
  if (m_preLoad.value()) {
    SG::ReadHandle<DataHeader> eventDataHeader(m_dataHeaderKey.value(), evtStore()->name());
    if (!eventDataHeader.isValid()) {
      ATH_MSG_ERROR("Cannot retrieve DataHeader from StoreGate: " << m_dataHeaderKey);
      return StatusCode::FAILURE;
    }
    for (const auto& element : *eventDataHeader) {
      SG::DataProxy* dp = evtStore()->proxy(element.getPrimaryClassID(), element.getKey());
      if (dp != 0 && dp->isValid()) {
        if (nullptr == dp->accessData()) {
          ATH_MSG_WARNING("unable to load proxy for " << element.getKey());
        }
      }
    }
  }
 
  if (m_failEvt.value() && !b) {
    ATH_MSG_ERROR("autoload of objects failed. aborting event processing");
    sc = StatusCode::FAILURE;
  }
 
  return sc;
}

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 SGInputLoader::finalize ( )

overridevirtual

Definition at line 89 of file SGInputLoader.cxx.

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

initialize()

StatusCode SGInputLoader::initialize ( )

overridevirtual

Definition at line 64 of file SGInputLoader.cxx.

{
  ATH_MSG_VERBOSE ("Initializing " << name() << "...");
 
  StatusCode sc(StatusCode::SUCCESS);
 
  if (m_load.size() > 0) {
    std::ostringstream str;
    str << "Will explicitly preload the following DataObjects:";
    for (auto &e : m_load) {
      str << "\n    + " << e;
      if (e.key().empty()) {
        sc = StatusCode::FAILURE;
        str << "   ERROR: empty key is not allowed!";
      }
    }
    ATH_MSG_INFO(str.str());
  }
 
  return sc;
}

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

bool SGInputLoader::isClonable ( ) const

inlineoverridevirtual

this Alg is Clonable (for AthenaMT)

Reimplemented from AthCommonAlgorithm< Gaudi::Algorithm >.

Definition at line 31 of file SGInputLoader.h.

{ return true; }

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

{ return false; }

loader()

void SGInputLoader::loader ( Gaudi::Details::PropertyBase & p )

private

Definition at line 190 of file SGInputLoader.cxx.

                                                  {
 
  ATH_MSG_DEBUG("Adding to outputs: " <<  p.toString());
 
  DataObjIDColl toLoad;
 
  for (auto obj : m_load) {
    // add an explicit storename as needed
    SG::VarHandleKey vhk(obj.clid(),obj.key(),Gaudi::DataHandle::Writer);
    obj.updateKey( vhk.objKey() );
    toLoad.emplace(obj);
    if(!outputDataObjs().count(obj)) { addDependency(obj,Gaudi::DataHandle::Writer); }
  }
  m_load = std::move(toLoad);
 
}

loadObjs()

bool SGInputLoader::loadObjs ( const DataObjIDColl & objs ) const

private

Definition at line 210 of file SGInputLoader.cxx.

                                                       {
 
  bool ok = true;
 
  for (auto &obj: objs) {
 
    std::string::size_type ppos = obj.key().substr(0,obj.key().size()-1).find('.');
 
    // use the parsing built into the VarHandleKey to get the correct
    // StoreGate key
    SG::VarHandleKey vhk(obj.clid(),obj.key().substr(0,ppos),Gaudi::DataHandle::Reader);
 
    ATH_MSG_DEBUG("trying to load " << obj << "   sgkey: " << vhk.key() );
 
    SG::DataProxy* dp = evtStore()->proxy(obj.clid(), vhk.key());
    if (dp != 0) {
      ATH_MSG_DEBUG(" found proxy for " << obj);
      if (dp->provider() == 0 && extraOutputDeps().find(obj)==extraOutputDeps().end()) {
        if(ppos==std::string::npos) {
          ATH_MSG_ERROR("   obj " << obj << " has no provider, and is only Transient - indicative of a missing output declaration" );
          ok =false;
        } else { // just warning for now for potentially undeclared decorations, instead of error, because too many cases to fix
          ATH_MSG_WARNING("   decoration " << obj << " has no provider, and is only Transient - either a decoration output declaration is missing, or a ReadDecorHandleKey is being used to read a non-decoration" );
        }
      }
    } else {
      ok = false;
      if (m_failEvt.value()) {
        ATH_MSG_ERROR("unable to find proxy for " << obj);
      } else {
        ATH_MSG_WARNING("unable to find proxy for " << obj);
      }
    }
  }
 
  return ok;
 
}

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

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_dataHeaderKey

Gaudi::Property<std::string> SGInputLoader::m_dataHeaderKey

private

Initial value:

{this, "DataHeaderKey", "EventSelector",
      "StoreGate key of event entry object"}

Definition at line 60 of file SGInputLoader.h.

                                          {this, "DataHeaderKey", "EventSelector",
      "StoreGate key of event entry object"};

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_dump

Gaudi::Property< bool > SGInputLoader::m_dump

private

Initial value:

{this, "ShowEventDump", false, 
      "printout contents of EventStore at end of execute()"}

Definition at line 48 of file SGInputLoader.h.

                               {this, "ShowEventDump", false, 
      "printout contents of EventStore at end of execute()"};

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_failEvt

Gaudi::Property<bool> SGInputLoader::m_failEvt

private

Initial value:

{this, "FailIfNoProxy", true, 
      "execute returns FAILURE if a requested proxy is not found in store"}

Definition at line 54 of file SGInputLoader.h.

                               {this, "FailIfNoProxy", true, 
      "execute returns FAILURE if a requested proxy is not found in store"};

m_first

bool SGInputLoader::m_first {true}

private

Definition at line 64 of file SGInputLoader.h.

{true};

m_load

DataObjIDColl SGInputLoader::m_load

private

Properties.

Definition at line 46 of file SGInputLoader.h.

m_loadProxies

Gaudi::Property<bool> SGInputLoader::m_loadProxies

private

Initial value:

{this, "LoadExtraProxies", true,
      "load the Proxies attributed to the SGInputLoader by the Scheduler"}

Definition at line 57 of file SGInputLoader.h.

                                   {this, "LoadExtraProxies", true,
      "load the Proxies attributed to the SGInputLoader by the Scheduler"};

m_preLoad

Gaudi::Property< bool > SGInputLoader::m_preLoad

private

Initial value:

{this, "PreLoadData", false, 
      "pre load EventStore data in execute()"}

Definition at line 51 of file SGInputLoader.h.

                                  {this, "PreLoadData", false, 
      "pre load EventStore data in execute()"};

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:

• SGInputLoader.h
• SGInputLoader.cxx