#include <AthCommonDataStore.h>

Inheritance diagram for AthCommonDataStore< PBASE >:

Collaboration diagram for AthCommonDataStore< PBASE >:

Public Member Functions
template<typename... T>
	AthCommonDataStore (const std::string &name, T... args)
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	evtStore () const
	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	sysInitialize () override
	Perform system initialization for an algorithm.
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.
template<class T, class V, class H>
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property.
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property.
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
void	updateVHKA (Gaudi::Details::PropertyBase &)
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property.
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
template<class T>
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
template<class T, class V, class H>
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
template<class T, class V, class H>
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
template<class T, class V, class H>
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase>
template<class T, class V, class H>
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Private Attributes
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

template<class PBASE>
class AthCommonDataStore< PBASE >

Definition at line 52 of file AthCommonDataStore.h.

Member Typedef Documentation

◆ StoreGateSvc_t

template<class PBASE>

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< PBASE >::StoreGateSvc_t

private

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ AthCommonDataStore()

template<class PBASE>

template<typename... T>

AthCommonDataStore< PBASE >::AthCommonDataStore	(	const std::string &	name,
		T...	args )

inline

Definition at line 55 of file AthCommonDataStore.h.

    : PBASE(name, std::move(args)...),
      m_evtStore    ( "StoreGateSvc/StoreGateSvc",  name ),
      m_detStore    ( "StoreGateSvc/DetectorStore", name ),
      m_varHandleArraysDeclared (false)
  {
 
    this->declareProperty( "EvtStore",
                     m_evtStore = StoreGateSvc_t ("StoreGateSvc", name),
                     "Handle to a StoreGateSvc instance: it will be used to "
                     "retrieve data during the course of the job" );
    
    this->declareProperty( "DetStore",
                     m_detStore = StoreGateSvc_t ("StoreGateSvc/DetectorStore", name),
                     "Handle to a StoreGateSvc/DetectorStore instance: it will be used to "
                     "retrieve data during the course of the job" );
 
    auto props = this->getProperties();
    for( Gaudi::Details::PropertyBase* prop : props ) {
      if (prop->name() == "ExtraOutputs" || prop->name() == "ExtraInputs") {
        prop->declareUpdateHandler
          (&AthCommonDataStore<PBASE>::extraDeps_update_handler, this);
      }
    }
  }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

template<class PBASE>

template<class T, class V, class H>

Gaudi::Details::PropertyBase & AthCommonDataStore< PBASE >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyArrayType &	)

inlineprivate

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]

template<class PBASE>

template<class T, class V, class H>

Gaudi::Details::PropertyBase & AthCommonDataStore< PBASE >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivate

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]

template<class PBASE>

template<class T, class V, class H>

Gaudi::Details::PropertyBase & AthCommonDataStore< PBASE >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleType &	)

inlineprivate

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]

template<class PBASE>

template<class T, class V, class H>

Gaudi::Details::PropertyBase & AthCommonDataStore< PBASE >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	t,
		const SG::NotHandleType &	)

inlineprivate

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]

template<class PBASE>

Gaudi::Details::PropertyBase * AthCommonDataStore< PBASE >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &	)

inline

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]

template<class PBASE>

Gaudi::Details::PropertyBase * AthCommonDataStore< PBASE >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &	)

inline

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]

template<class PBASE>

Gaudi::Details::PropertyBase * AthCommonDataStore< PBASE >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &	)

inline

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]

template<class PBASE>

template<class T>

Gaudi::Details::PropertyBase * AthCommonDataStore< PBASE >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &	)

inline

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]

template<class PBASE>

template<class T>

Gaudi::Details::PropertyBase * AthCommonDataStore< PBASE >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = "none" )

inline

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]

template<class PBASE>

template<class T, class V, class H>

Gaudi::Details::PropertyBase & AthCommonDataStore< PBASE >::declareProperty ( Gaudi::Property< T, V, H > & t )

inline

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

template<class PBASE>

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< PBASE >::detStore ( ) const

inline

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]

template<class PBASE>

ServiceHandle< StoreGateSvc > & AthCommonDataStore< PBASE >::evtStore ( )

inline

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]

template<class PBASE>

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< PBASE >::evtStore ( ) const

inline

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

◆ extraDeps_update_handler()

template<class PBASE>

void AthCommonDataStore< PBASE >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protected

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

◆ inputHandles()

template<class PBASE>

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< PBASE >::inputHandles ( ) const

overridevirtual

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.

◆ outputHandles()

template<class PBASE>

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< PBASE >::outputHandles ( ) const

overridevirtual

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

template<class PBASE>

template<class T>

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< PBASE >::renounce ( T & h )

inlineprotected

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

template<class PBASE>

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

inlineprotected

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

template<class PBASE>

virtual StatusCode AthCommonDataStore< PBASE >::sysInitialize ( )

overridevirtual

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthAlgorithm, AthAnalysisAlgorithm, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, AthCommonReentrantAlgorithm< BaseAlg >, AthCommonReentrantAlgorithm< Gaudi::Algorithm >, AthCommonReentrantAlgorithm< Gaudi::AsynchronousAlgorithm >, AthFilterAlgorithm, AthHistogramAlgorithm, DerivationFramework::CfAthAlgTool, HypoBase, InputMakerBase, and PyAthena::Alg.

◆ sysStart()

template<class PBASE>

virtual StatusCode AthCommonDataStore< PBASE >::sysStart ( )

overridevirtual

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

template<class PBASE>

void AthCommonDataStore< PBASE >::updateVHKA ( Gaudi::Details::PropertyBase & )

inline

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

template<class PBASE>

StoreGateSvc_t AthCommonDataStore< PBASE >::m_detStore

private

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

template<class PBASE>

StoreGateSvc_t AthCommonDataStore< PBASE >::m_evtStore

private

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_varHandleArraysDeclared

template<class PBASE>

bool AthCommonDataStore< PBASE >::m_varHandleArraysDeclared

private

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

template<class PBASE>

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< PBASE >::m_vhka

private

Definition at line 398 of file AthCommonDataStore.h.

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

AthCommonDataStore.h

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ AthCommonDataStore()

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]

◆ extraDeps_update_handler()

◆ inputHandles()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka