xAODMaker::AuxStoreWrapper Class Reference

Algorithm preparing auxiliary store objects for slimming. More...

#include <AuxStoreWrapper.h>

Inheritance diagram for xAODMaker::AuxStoreWrapper:

Collaboration diagram for xAODMaker::AuxStoreWrapper:

Public Member Functions
	AuxStoreWrapper (const std::string &name, ISvcLocator *svcLoc)
	Regular Algorithm constructor. More...
virtual StatusCode	initialize ()
	Function initialising the algorithm. More...
virtual StatusCode	execute ()
	Function executing the algorithm. More...
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
StatusCode	changeContainer (const SG::IAuxStore *store, const std::string &name)
	Create a new container store. More...
StatusCode	changeElement (const SG::IAuxStore *store, const std::string &name)
	Create a new element store. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::vector< std::string >	m_keys
	StoreGate keys of the store objects to be wrapped. More...
std::set< std::string >	m_keysSet
	Keys of the objects to be wrapped, in a set container. More...
bool	m_cachesSet
	Flag specifying whether the internal caches were set already. More...
std::set< std::string >	m_toConvert
	Keys of the auxiliary stores that need to be converted in the end. More...
std::map< std::string, CLID >	m_clids
	Keys and CLIDs of the interface containers touched. More...
ServiceHandle< ::IClassIDSvc >	m_clidSvc
	Handle to the Class ID service. More...
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

Algorithm preparing auxiliary store objects for slimming.

   This algorithm can be used to update some or all of the auxiliary
   store objects in StoreGate to save all of their auxiliary
   variables as separate branches in the output TTree.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 41 of file AuxStoreWrapper.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

AuxStoreWrapper()

xAODMaker::AuxStoreWrapper::AuxStoreWrapper	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

Regular Algorithm constructor.

Definition at line 49 of file AuxStoreWrapper.cxx.

      : AthAlgorithm( name, svcLoc ), m_cachesSet( false ),
        m_clidSvc( "ClassIDSvc", name ) {
 
      declareProperty( "SGKeys", m_keys,
                       "StoreGate keys of the store objects to be wrapped" );
      declareProperty( "ClassIDSvc", m_clidSvc, "Service providing CLID info" );
   }

Member Function Documentation

changeContainer()

StatusCode xAODMaker::AuxStoreWrapper::changeContainer ( const SG::IAuxStore *  store, const std::string &  name  )

private

Create a new container store.

Definition at line 187 of file AuxStoreWrapper.cxx.

                                                                        {
 
      // Make StoreGate forget about this object:
      auto aux_clid_itr = m_clids.find( name );
      if( aux_clid_itr == m_clids.end() ) {
         ATH_MSG_FATAL( "Didn't find a CLID for key: " << name );
         ATH_MSG_FATAL( "This is an internal logic error" );
         return StatusCode::FAILURE;
      }
      evtStore()->releaseObject( aux_clid_itr->second, name );
      ATH_MSG_VERBOSE( "Released object with CLID " << aux_clid_itr->second
                       << " and name \"" << name << "\"" );
 
      // Get the pointer for the proxy of the auxiliary store:
      SG::DataProxy* storeProxy =
         evtStore()->proxy( ClassID_traits< SG::IAuxStore >::ID(), name );
      if( ! storeProxy ) {
         ATH_MSG_FATAL( "Couldn't get proxy for the "
                        "SG::IAuxStore base class of: " << name );
         return StatusCode::FAILURE;
      }
      // Now make StoreGate forget about this proxy completely:
      CHECK( evtStore()->removeProxy( storeProxy, nullptr, true ) );
 
      // Create the new object as a wrapper around the original:
      xAOD::AuxContainerBase* holder = new xAOD::AuxContainerBase();
      holder->setStore( const_cast< SG::IAuxStore* >( store ) );
 
      // Record the new container with the same key:
      CHECK( evtStore()->overwrite( holder, name, false, true ) );
 
      ATH_MSG_DEBUG( "Overwrote store object with key \""
                     << name << "\" with an xAOD::AuxContainerBase "
                     << "object" );
 
      // The key of the interface container:
      const std::string intName = name.substr( 0, name.size() - 4 );
 
      // The CLID for the interface container:
      CLID intId = 0;
      auto clid_itr = m_clids.find( intName );
      if( clid_itr == m_clids.end() ) {
         ATH_MSG_WARNING( "Didn't cache a CLID for key: " << intName );
         ATH_MSG_WARNING( "Interface container can't be updated, the job will "
                          "likely crash" );
         return StatusCode::SUCCESS;
      }
      intId = clid_itr->second;
 
      // Try to access the proxy for the interface container:
      SG::DataProxy* proxy = evtStore()->proxy( intId, intName );
      if( ! proxy ) {
         // If there is none, return at this point:
         ATH_MSG_VERBOSE( "Interface container with key \"" << intName
                          << "\" not available" );
         return StatusCode::SUCCESS;
      }
 
      // Get the raw pointer to the object:
      void* ptr = SG::DataProxy_cast( proxy, intId );
      if( ! ptr ) {
         REPORT_ERROR( StatusCode::FAILURE )
            << "Couldn't retrieve raw pointer to interface container";
         return StatusCode::FAILURE;
      }
 
      // Since all the "wrapped" objects should be xAOD objects, for which
      // the interface containers all implement a straight inheritance tree
      // back to SG::AuxVectorBase, the following ugly operation should be
      // safe:
      SG::AuxVectorBase* interface =
         reinterpret_cast< SG::AuxVectorBase* >( ptr );
 
      // And now connect the interface to the store depending on the const-ness
      // of the interface:
      if( proxy->isConst() ) {
         interface->setConstStore( holder );
      } else {
         interface->setStore( holder );
      }
 
      ATH_MSG_DEBUG( "Interface container with key \"" << intName
                     << "\" updated" );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

changeElement()

StatusCode xAODMaker::AuxStoreWrapper::changeElement ( const SG::IAuxStore *  store, const std::string &  name  )

private

Create a new element store.

Definition at line 276 of file AuxStoreWrapper.cxx.

                                                                      {
 
      // Make StoreGate forget about this object:
      auto aux_clid_itr = m_clids.find( name );
      if( aux_clid_itr == m_clids.end() ) {
         ATH_MSG_FATAL( "Didn't find a CLID for key: " << name );
         ATH_MSG_FATAL( "This is an internal logic error" );
         return StatusCode::FAILURE;
      }
      evtStore()->releaseObject( aux_clid_itr->second, name );
      ATH_MSG_VERBOSE( "Released object with CLID " << aux_clid_itr->second
                       << " and name \"" << name << "\"" );
 
      // Create the new as a wrapper around the original:
      xAOD::AuxInfoBase* holder = new xAOD::AuxInfoBase();
      holder->setStore( const_cast< SG::IAuxStore* >( store ) );
 
      // Record the new container with a different key:
      CHECK( evtStore()->overwrite( holder, name, false, true ) );
 
      ATH_MSG_DEBUG( "Wrapped store object with key \""
                     << name << "\" into xAOD::AuxInfoBase "
                     << "object" );
 
       // The key of the interface object:
      const std::string intName = name.substr( 0, name.size() - 4 );
 
      // The CLID for the interface object:
      CLID intId = 0;
      auto clid_itr = m_clids.find( intName );
      if( clid_itr == m_clids.end() ) {
         ATH_MSG_WARNING( "Didn't cache a CLID for key: " << intName );
         ATH_MSG_WARNING( "Interface object can't be updated, the job will "
                          "likely crash" );
         return StatusCode::SUCCESS;
      }
      intId = clid_itr->second;
 
      // Try to access the proxy for the interface object:
      SG::DataProxy* proxy = evtStore()->proxy( intId, intName );
      if( ! proxy ) {
         // If there is none, return at this point:
         ATH_MSG_VERBOSE( "Interface object with key \"" << intName
                          << "\" not available" );
         return StatusCode::SUCCESS;
      }
 
      // Get the raw pointer to the object:
      void* ptr = SG::DataProxy_cast( proxy, intId );
      if( ! ptr ) {
         REPORT_ERROR( StatusCode::FAILURE )
            << "Couldn't retrieve raw pointer to interface object";
         return StatusCode::FAILURE;
      }
 
      // Since all the "wrapped" objects should be xAOD objects, for which
      // the interface objects all implement a straight inheritance tree
      // back to SG::AuxElement, the following ugly operation should be
      // safe:
      SG::AuxElement* interface =
         reinterpret_cast< SG::AuxElement* >( ptr );
 
      // And now connect the interface to the store depending on the const-ness
      // of the interface:
      if( proxy->isConst() ) {
         interface->setConstStore( holder );
      } else {
         interface->setStore( holder );
      }
 
      ATH_MSG_DEBUG( "Interface object with key \"" << intName
                     << "\" updated" );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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.

{ 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.

{ 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.

{ return m_evtStore; }

execute()

StatusCode xAODMaker::AuxStoreWrapper::execute ( )

virtual

Function executing the algorithm.

Definition at line 80 of file AuxStoreWrapper.cxx.

                                       {
 
      // The StoreGate content before the object wrapping:
      ATH_MSG_VERBOSE( "Event store before wrapping:\n" << evtStore()->dump() );
 
      // If we don't have a list of keys to be converted yet, get one now:
      if( ! m_cachesSet ) {
 
         // Ask StoreGate for all the objects that it's holding on to:
         const std::vector< const SG::DataProxy* > proxies =
            evtStore()->proxies();
 
         // Loop over them:
         for( const SG::DataProxy* proxy : proxies ) {
 
            ATH_MSG_VERBOSE( "Evaluating object with name \"" << proxy->name()
                             << "\" and CLID " << proxy->clID() );
 
            // Check if we need to worry about this object:
            if( !m_keysSet.empty() ) {
               if( m_keysSet.find( proxy->name() ) == m_keysSet.end() ) {
                  // This SG key was not mentioned in the jobOptions...
                  ATH_MSG_VERBOSE( "Conversion for this key was not "
                                   "requested" );
                  // But if this is a proxy for an interface container for which
                  // we wrap the auxiliary container, then let's remember it.
                  if( m_keysSet.find( proxy->name() + "Aux." ) !=
                      m_keysSet.end() ) {
                     std::string typeName;
                     ATH_CHECK( m_clidSvc->getTypeNameOfID( proxy->clID(),
                                                            typeName ) );
                     if( typeName.compare( 0, 6, "xAOD::" ) == 0) {
                        m_clids[ proxy->name() ] = proxy->clID();
                     }
                  }
                  continue;
               }
            }
            ATH_MSG_VERBOSE( "The wrapping of this object was requested" );
 
            // Remember the CLID of this type, if it's an xAOD type:
            std::string typeName;
            ATH_CHECK( m_clidSvc->getTypeNameOfID( proxy->clID(),
                                                   typeName ) );
            if( ( typeName.compare( 0, 6 , "xAOD::") == 0) &&
                ( typeName != "xAOD::ByteStreamAuxContainer_v1" ) ) {
               m_clids[ proxy->name() ] = proxy->clID();
            }
 
            // Check if the key of the object looks like it is an auxiliary
            // store. (To try to avoid unnecessary warnings.)
            if( proxy->name().find( "Aux." ) !=
                ( proxy->name().size() - 4 ) ) {
               ATH_MSG_VERBOSE( "Key doesn't look like that of an auxiliary "
                                << "store" );
               continue;
            }
            ATH_MSG_VERBOSE( "StoreGate key looks like that of an auxiliary "
                             << "store..." );
 
            // This object/container will be converted:
            m_toConvert.insert( proxy->name() );
         }
 
         // The caches are now set:
         m_cachesSet = true;
      }
 
      // Now do the wrapping on the selected objects/containers:
      for( const std::string& name : m_toConvert ) {
 
         // Tell the user what's happening:
         ATH_MSG_VERBOSE( "Now wrapping object: " << name );
 
         // Access the object with an SG::IAuxStore pointer:
         const SG::IAuxStore* original = nullptr;
         if( ! evtStore()->retrieve( original, name ).isSuccess() ) {
            ATH_MSG_WARNING( "Couldn't retrieve object \"" << name << "\" "
                             << "with interface SG::IAuxStore" );
            continue;
         }
 
         // Check if the object implements the IAuxStoreHolder interface
         // as well.
         const SG::IAuxStoreHolder* holder =
            dynamic_cast< const SG::IAuxStoreHolder* >( original );
         if( ! holder ) {
            // If not, let's just assume that it describes a container.
            CHECK( changeContainer( original, name ) );
            continue;
         }
 
         // Decide how to replace it exactly:
         if( holder->getStoreType() == SG::IAuxStoreHolder::AST_ObjectStore ) {
            CHECK( changeElement( original, name ) );
         } else {
            CHECK( changeContainer( original, name ) );
         }
      }
 
      // The StoreGate content before the object wrapping:
      ATH_MSG_VERBOSE( "Event store after wrapping:\n" << evtStore()->dump() );
 
      // Return gracefully:
      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();
}

initialize()

StatusCode xAODMaker::AuxStoreWrapper::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 59 of file AuxStoreWrapper.cxx.

                                          {
 
      ATH_MSG_INFO( "Initialising" );
      ATH_MSG_DEBUG( "  StoreGate keys: " << m_keys );
 
      // Retrieve the needed component(s):
      ATH_CHECK( m_clidSvc.retrieve() );
 
      // Pack the SG keys into a structure that's more efficient during
      // event processing:
      m_keysSet.insert( m_keys.begin(), m_keys.end() );
 
      // Reset the caches:
      m_cachesSet = false;
      m_toConvert.clear();
      m_clids.clear();
 
      // Return gracefully:
      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() [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_cachesSet

bool xAODMaker::AuxStoreWrapper::m_cachesSet

private

Flag specifying whether the internal caches were set already.

Definition at line 66 of file AuxStoreWrapper.h.

m_clids

std::map< std::string, CLID > xAODMaker::AuxStoreWrapper::m_clids

private

Keys and CLIDs of the interface containers touched.

Definition at line 70 of file AuxStoreWrapper.h.

m_clidSvc

ServiceHandle< ::IClassIDSvc > xAODMaker::AuxStoreWrapper::m_clidSvc

private

Handle to the Class ID service.

Definition at line 73 of file AuxStoreWrapper.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_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_keys

std::vector< std::string > xAODMaker::AuxStoreWrapper::m_keys

private

StoreGate keys of the store objects to be wrapped.

Definition at line 61 of file AuxStoreWrapper.h.

m_keysSet

std::set< std::string > xAODMaker::AuxStoreWrapper::m_keysSet

private

Keys of the objects to be wrapped, in a set container.

Definition at line 63 of file AuxStoreWrapper.h.

m_toConvert

std::set< std::string > xAODMaker::AuxStoreWrapper::m_toConvert

private

Keys of the auxiliary stores that need to be converted in the end.

Definition at line 68 of file AuxStoreWrapper.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:

• AuxStoreWrapper.h
• AuxStoreWrapper.cxx