#include <HiveAlgV.h>

Inheritance diagram for HiveAlgV:

Collaboration diagram for HiveAlgV:

Public Member Functions
	HiveAlgV (const std::string &name, ISvcLocator *pSvcLocator)
	~HiveAlgV ()
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual bool	isClonable () const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
unsigned int	sleep ()
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.

Protected Attributes
ServiceHandle< IHiveExSvc >	m_hes {this,"HiveExSvc","HiveExSvc","Handle to HiveExSvc"}
ServiceHandle< ICPUCrunchSvc >	m_ccs {this,"CPUCrunchSvc","CPUCrunchSvc","Handle to CPUCrunchSvc"}
ServiceHandle< IAthRNGSvc >	m_rngSvc {this,"AthRNGSvc","AthRNGSvc","Handle to random number service"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	read () const
StatusCode	write ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< bool >	m_writeFirst
SG::ReadHandleKeyArray< HiveDataObj >	m_rhv
SG::WriteHandleKeyArray< HiveDataObj >	m_whv
Gaudi::Property< unsigned int >	m_time {this, "Time", 0, "default alg sleep time in ms"}
Gaudi::Property< bool >	m_doCrunch {this, "Crunch", false, "Crunch instead of Sleep"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 21 of file HiveAlgV.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

◆ HiveAlgV()

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

Definition at line 8 of file HiveAlgV.cxx.

                                       : 
  ::HiveAlgBase( name, pSvcLocator )
{}

◆ ~HiveAlgV()

HiveAlgV::~HiveAlgV ( )

default

Member Function Documentation

◆ declareGaudiProperty()

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

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode HiveAlgV::execute ( )

overridevirtual

Definition at line 31 of file HiveAlgV.cxx.

                             {
 
  ATH_MSG_DEBUG("execute " << name());
 
  sleep();
 
  if (m_writeFirst) {
    ATH_CHECK(write());
    ATH_CHECK(read());
  } else {
    ATH_CHECK(read());
    ATH_CHECK(write());
  }
 
  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 HiveAlgV::initialize ( )

overridevirtual

Reimplemented from HiveAlgBase.

Definition at line 17 of file HiveAlgV.cxx.

                                {
  ATH_MSG_DEBUG("initialize " << name());
 
  ATH_CHECK( m_rhv.initialize() );
  ATH_CHECK( m_whv.initialize() );
 
  ATH_MSG_INFO(m_rhv.keys() << " : " << m_rhv.size());
  ATH_MSG_INFO(m_whv.keys() << " : " << m_whv.size());
 
  // initialize base class
  return HiveAlgBase::initialize ();
}

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

◆ isClonable()

virtual bool HiveAlgBase::isClonable ( ) const

inlineoverridevirtualinherited

Definition at line 34 of file HiveAlgBase.h.

34{ return true; }

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

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

◆ read()

StatusCode HiveAlgV::read ( ) const

private

Definition at line 50 of file HiveAlgV.cxx.

                     {
  StatusCode sc { StatusCode::SUCCESS };
  std::vector< SG::ReadHandle<HiveDataObj> > rhv = m_rhv.makeHandles();
  for (auto &hnd : rhv) {
    if (!hnd.isValid()) {
      ATH_MSG_ERROR ("Could not retrieve HiveDataObj with key " << hnd.key());
      sc = StatusCode::FAILURE;
    } else {
      ATH_MSG_INFO("  read: " << hnd.key() << " = " << hnd->val() );
    }
  }
  return sc;
}

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

◆ sleep()

unsigned int HiveAlgBase::sleep ( )

protectedinherited

Definition at line 40 of file HiveAlgBase.cxx.

                   {
 
  const auto& ctx = Gaudi::Hive::currentContext();
  ATHRNG::RNGWrapper* rngWrapper = m_rngSvc->getEngine(this);
  rngWrapper->setSeed( name(), ctx );
 
  // add a bit of variability to the sleep/crunch time
  const unsigned int sleep = CLHEP::RandFlat::shoot(rngWrapper->getEngine(ctx), 0, m_time);
 
  if (m_doCrunch) {
    ATH_MSG_INFO("  crunch for: " << sleep << " ms");
    m_ccs->crunch_for( std::chrono::milliseconds(sleep) );
  } else {
    ATH_MSG_INFO("  sleep for: " << sleep << " ms");
    std::this_thread::sleep_for(std::chrono::milliseconds( sleep ));
  }
 
  // accumulate data in the HiveExSvc
  m_hes->add( name(),sleep );
 
  return sleep;
 
}

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

◆ write()

StatusCode HiveAlgV::write ( )

private

Definition at line 66 of file HiveAlgV.cxx.

                {
  std::vector< SG::WriteHandle<HiveDataObj> > whv = m_whv.makeHandles();
  for (auto &hnd : whv) {
    ATH_CHECK(hnd.record(std::make_unique<HiveDataObj>( 10101 )));
    ATH_MSG_INFO("  write: " << hnd.key() << " = " << hnd->val() );
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_ccs

ServiceHandle<ICPUCrunchSvc> HiveAlgBase::m_ccs {this,"CPUCrunchSvc","CPUCrunchSvc","Handle to CPUCrunchSvc"}

protectedinherited

Definition at line 47 of file HiveAlgBase.h.

47{this,"CPUCrunchSvc","CPUCrunchSvc","Handle to CPUCrunchSvc"};

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

Gaudi::Property<bool> HiveAlgBase::m_doCrunch {this, "Crunch", false, "Crunch instead of Sleep"}

privateinherited

Definition at line 55 of file HiveAlgBase.h.

55{this, "Crunch", false, "Crunch instead of Sleep"};

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

ServiceHandle<IHiveExSvc> HiveAlgBase::m_hes {this,"HiveExSvc","HiveExSvc","Handle to HiveExSvc"}

protectedinherited

Definition at line 44 of file HiveAlgBase.h.

44{this,"HiveExSvc","HiveExSvc","Handle to HiveExSvc"};

◆ m_rhv

SG::ReadHandleKeyArray<HiveDataObj> HiveAlgV::m_rhv

private

Initial value:

{
    this, "Key_RV", {"a1","a2","d1","e1","c1"},
    "Array of ReadHandleKey<HiveDataObj>" }

Definition at line 40 of file HiveAlgV.h.

                                          {
    this, "Key_RV", {"a1","a2","d1","e1","c1"},
    "Array of ReadHandleKey<HiveDataObj>" };

◆ m_rngSvc

ServiceHandle<IAthRNGSvc> HiveAlgBase::m_rngSvc {this,"AthRNGSvc","AthRNGSvc","Handle to random number service"}

protectedinherited

Definition at line 50 of file HiveAlgBase.h.

50{this,"AthRNGSvc","AthRNGSvc","Handle to random number service"};

◆ m_time

Gaudi::Property<unsigned int> HiveAlgBase::m_time {this, "Time", 0, "default alg sleep time in ms"}

privateinherited

Definition at line 54 of file HiveAlgBase.h.

54{this, "Time", 0, "default alg sleep time in ms"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_whv

SG::WriteHandleKeyArray<HiveDataObj> HiveAlgV::m_whv

private

Initial value:

{

this, "Key_WV", {}, "Array of WriteHandleKey<HiveDataObj>" }

Definition at line 44 of file HiveAlgV.h.

44 {

45 this, "Key_WV", {}, "Array of WriteHandleKey<HiveDataObj>" };

◆ m_writeFirst

Gaudi::Property<bool> HiveAlgV::m_writeFirst

private

Initial value:

{this, "WriteBeforeRead", true,

"do write before the read" }

Definition at line 37 of file HiveAlgV.h.

37 {this, "WriteBeforeRead", true,

38 "do write before the read" };

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HiveAlgV()

◆ ~HiveAlgV()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ read()

◆ renounce()

◆ renounceArray()

◆ sleep()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ write()

Member Data Documentation

◆ m_ccs

◆ m_detStore

◆ m_doCrunch

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_hes

◆ m_rhv

◆ m_rngSvc

◆ m_time

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_whv

◆ m_writeFirst