CondSvc Class Reference

#include <CondSvc.h>

Inheritance diagram for CondSvc:

Collaboration diagram for CondSvc:

Public Member Functions
	CondSvc (const std::string &name, ISvcLocator *svc)
virtual StatusCode	initialize () override
virtual StatusCode	start () override
virtual StatusCode	stop () override
virtual StatusCode	regHandle (IAlgorithm *alg, const Gaudi::DataHandle &id) override
virtual bool	isValidID (const EventContext &, const DataObjID &) const override
virtual const std::set< IAlgorithm * > &	condAlgs () const override
virtual bool	isRegistered (const DataObjID &id) const override
virtual bool	isRegistered (IAlgorithm *ialg) const override
virtual const DataObjIDColl &	conditionIDs () const override
virtual StatusCode	validRanges (std::vector< EventIDRange > &ranges, const DataObjID &id) const override
virtual void	dump (std::ostream &) const override
virtual StatusCode	setupDone () override
	To be called after changes to the set of conditions containers in the conditions store.
virtual ConditionSlotFuture *	startConditionSetup (const EventContext &) override
	unimplemented interfaces
virtual StatusCode	registerConditionIOSvc (IConditionIOSvc *) override
	register an IConditionIOSvc (alternative to Algorithm processing of Conditions)

Private Member Functions
StatusCode	regHandle_i (IAlgorithm *alg, const Gaudi::DataHandle &id)

Private Attributes
ServiceHandle< StoreGateSvc >	m_sgs
std::set< IAlgorithm * >	m_condAlgs
DataObjIDColl	m_condIDs
std::unordered_map< DataObjID, IAlgorithm *, DataObjID_Hasher >	m_idMap
	Map from DataObjID to Algorithm to avoid duplicates.
std::unordered_map< DataObjID, const CondContBase *, DataObjID_Hasher >	m_condConts
	Map from DataObjID to CondContBase (populated in setupDone).
std::mutex	m_lock

Detailed Description

Definition at line 22 of file CondSvc.h.

Constructor & Destructor Documentation

CondSvc()

CondSvc::CondSvc	(	const std::string &	name,
		ISvcLocator *	svc )

Definition at line 13 of file CondSvc.cxx.

                                                            :
  base_class(name,svcLoc),
  m_sgs("StoreGateSvc/ConditionStore", name)
{
}

Member Function Documentation

condAlgs()

virtual const std::set< IAlgorithm * > & CondSvc::condAlgs ( ) const

inlineoverridevirtual

Definition at line 35 of file CondSvc.h.

{ return m_condAlgs; }

conditionIDs()

virtual const DataObjIDColl & CondSvc::conditionIDs ( ) const

inlineoverridevirtual

Definition at line 38 of file CondSvc.h.

{ return m_condIDs; }

dump()

void CondSvc::dump ( std::ostream & ost ) const

overridevirtual

Definition at line 53 of file CondSvc.cxx.

                                   {
 
  std::scoped_lock lock(m_lock);
 
  ost << "CondSvc::dump()";
 
  ost << "\ndumping id->alg map\n";
  for (const auto& [id, alg] : m_idMap) {
    ost << "\n + " << id << " : " << alg->name();
  }
 
  ost << "\n\ndumping ConditionStore:\n\n";
 
  SG::ConstIterator<CondContBase> cib,cie;
  if (m_sgs->retrieve(cib,cie).isSuccess()) {
    while (cib != cie) {
      ost << " + ";
      cib->list(ost);
      ++cib;
    }
  }
 
  ost << "\n";
    
}

initialize()

StatusCode CondSvc::initialize ( )

overridevirtual

Definition at line 42 of file CondSvc.cxx.

                    {
 
  ATH_CHECK( m_sgs.retrieve() );
 
  return StatusCode::SUCCESS;
 
}

isRegistered() [1/2]

virtual bool CondSvc::isRegistered ( const DataObjID & id ) const

inlineoverridevirtual

Definition at line 36 of file CondSvc.h.

{ return m_condIDs.contains(id); }

isRegistered() [2/2]

virtual bool CondSvc::isRegistered ( IAlgorithm * ialg ) const

inlineoverridevirtual

Definition at line 37 of file CondSvc.h.

{ return m_condAlgs.contains(ialg); }

isValidID()

bool CondSvc::isValidID ( const EventContext & ctx, const DataObjID & id ) const

overridevirtual

Definition at line 166 of file CondSvc.cxx.

                                                                     {
  // Don't take out the lock here.
  // In many-thread jobs, a lock here becomes heavily contended.
  // The only potential conflict is with setupDone(),
  // which should only be called during START.
 
  auto it = m_condConts.find (id);
  if (it != m_condConts.end()) {
    const bool valid = it->second->valid (ctx.eventID());
    ATH_MSG_VERBOSE("CondSvc::isValidID:  now: " << ctx.eventID() << "  id : "
                    << id << (valid ? ": T" : ": F") );
    return valid;
  }
  else {
    ATH_MSG_ERROR( "Cannot find CondCont " << id );
  }
 
  return false;
 
}

regHandle()

StatusCode CondSvc::regHandle ( IAlgorithm * alg, const Gaudi::DataHandle & id )

overridevirtual

Definition at line 109 of file CondSvc.cxx.

                                                             {
 
  std::scoped_lock lock(m_lock);
  return regHandle_i(alg, dh);
 
}

regHandle_i()

StatusCode CondSvc::regHandle_i ( IAlgorithm * alg, const Gaudi::DataHandle & id )

private

Definition at line 120 of file CondSvc.cxx.

                                                               {
 
  ATH_MSG_DEBUG( "regHandle: alg: " << alg->name() << "  id: "
                 << dh.fullKey() );
 
  if (dh.mode() != Gaudi::DataHandle::Writer) {
    ATH_MSG_DEBUG(dh.fullKey() << " is a ReadHandle. No need to register.");
    return StatusCode::SUCCESS;
  }
 
  const auto [itr, success] = m_idMap.try_emplace(dh.fullKey(), alg);
  if (!success) {
    const IAlgorithm *ia = itr->second;
    if (ia->name() != alg->name()) {
      ATH_MSG_ERROR("WriteCondHandle " << dh.fullKey()
                    << " is already registered against a different Algorithm "
                    << ia->name()
                    << ". This is not allowed.");
      return StatusCode::FAILURE;
    }
  }
 
  m_condAlgs.emplace(alg);
  m_condIDs.emplace( dh.fullKey() );
 
  StatusCode sc{StatusCode::SUCCESS};
 
  const CLID clid = dh.fullKey().clid();
  const SG::BaseInfoBase* bib = SG::BaseInfoBase::find( clid );
  if ( bib ) {
    for (CLID clid2 : bib->get_bases()) {
      if (clid2 != clid) {
        SG::VarHandleKey vhk(clid2,dh.objKey(),Gaudi::DataHandle::Writer,
                             StoreID::storeName(StoreID::CONDITION_STORE));
        sc &= regHandle_i(alg, vhk);
      }
    }
  }
 
  return sc;
}

registerConditionIOSvc()

virtual StatusCode CondSvc::registerConditionIOSvc ( IConditionIOSvc * )

inlineoverridevirtual

register an IConditionIOSvc (alternative to Algorithm processing of Conditions)

Definition at line 60 of file CondSvc.h.

                                                                        {
    return StatusCode::FAILURE;
  }

setupDone()

StatusCode CondSvc::setupDone ( )

overridevirtual

To be called after changes to the set of conditions containers in the conditions store.

Create DataObjID -> CondCont map for usage in isValidID.

May not be called concurrently with any other methods of this class.

As some conditions are looked up via their base class, we need to register each CondCont key against all its possible bases.

Definition at line 195 of file CondSvc.cxx.

{
  std::scoped_lock lock(m_lock);
 
  // CondHandleKeys always carry the store prefix. Prepend it to the raw key name.
  const std::string& storePrefix = StoreID::storeName(StoreID::CONDITION_STORE) + "+";
 
  SG::ConstIterator<CondContBase> cib, cie;
  if (m_sgs->retrieve(cib,cie).isSuccess()) {
    while(cib != cie) {
      // CLID of CondCont payload
      CLID clid = cib->id().clid();
      const SG::BaseInfoBase* bib = SG::BaseInfoBase::find(clid);
      if ( !bib ) {
        // If no bases, register type
        m_condConts.try_emplace( DataObjID(clid, storePrefix + cib.key()), &*cib );
      }
      else {
        // Otherwise register all bases (which includes itself)
        for (CLID clid2 : bib->get_bases()) {
          m_condConts.try_emplace( DataObjID(clid2, storePrefix + cib.key()), &*cib );
        }
      }
      ++cib;
    }
  }
 
  return StatusCode::SUCCESS;
}

start()

StatusCode CondSvc::start ( )

overridevirtual

Definition at line 82 of file CondSvc.cxx.

{
  // Call this now, in case there is no CondInputLoader.
  ATH_CHECK( setupDone() );
  return StatusCode::SUCCESS;
}

startConditionSetup()

virtual ConditionSlotFuture * CondSvc::startConditionSetup ( const EventContext & )

inlineoverridevirtual

unimplemented interfaces

Asynchronously setup conditions

Definition at line 54 of file CondSvc.h.

                                                                                 {
    return nullptr;
  }

stop()

StatusCode CondSvc::stop ( )

overridevirtual

Definition at line 91 of file CondSvc.cxx.

              {
 
  ATH_MSG_DEBUG( "CondSvc::stop()" );
 
  if (msgLvl(MSG::DEBUG)) {
    std::ostringstream ost;
    dump(ost);
    
    ATH_MSG_DEBUG( ost.str() );
  }
 
  return StatusCode::SUCCESS;
 
}

validRanges()

StatusCode CondSvc::validRanges ( std::vector< EventIDRange > & ranges, const DataObjID & id ) const

overridevirtual

Definition at line 22 of file CondSvc.cxx.

{
  // Retrieve all conditions data and search
  SG::ConstIterator< CondContBase > cib, cie;
  StatusCode sc = m_sgs->retrieve( cib, cie );
  if ( sc.isSuccess() ) {
    while ( cib != cie ) {
      if ( cib->id() == id ) {
        ranges = cib->ranges();
      }
      ++cib;
    }
  }
 
  return sc;
}

Member Data Documentation

m_condAlgs

std::set<IAlgorithm*> CondSvc::m_condAlgs

private

Definition at line 72 of file CondSvc.h.

m_condConts

std::unordered_map<DataObjID, const CondContBase*, DataObjID_Hasher> CondSvc::m_condConts

private

Map from DataObjID to CondContBase (populated in setupDone).

Definition at line 79 of file CondSvc.h.

m_condIDs

DataObjIDColl CondSvc::m_condIDs

private

Definition at line 73 of file CondSvc.h.

m_idMap

std::unordered_map<DataObjID, IAlgorithm*, DataObjID_Hasher> CondSvc::m_idMap

private

Map from DataObjID to Algorithm to avoid duplicates.

Definition at line 76 of file CondSvc.h.

m_lock

std::mutex CondSvc::m_lock

mutableprivate

Definition at line 81 of file CondSvc.h.

m_sgs

ServiceHandle<StoreGateSvc> CondSvc::m_sgs

private

Definition at line 70 of file CondSvc.h.

---

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

• CondSvc.h
• CondSvc.cxx