#include <TBDetDescrLoader.h>

Inheritance diagram for TBDetDescrLoader:

Collaboration diagram for TBDetDescrLoader:

Public Member Functions
	TBDetDescrLoader (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~TBDetDescrLoader ()
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () 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
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_TBDetDescrManager
std::string	m_TBElementContainer
int	m_readAction
int	m_writeAction
TBDetDescrManager *	m_TBDDM
const TBDetDescrManager *	c_TBDDM
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 14 of file TBDetDescrLoader.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

◆ TBDetDescrLoader()

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

Definition at line 17 of file TBDetDescrLoader.cxx.

  : AthAlgorithm(name, pSvcLocator),
    m_TBDDM(0),
    c_TBDDM(0)
{
  declareProperty("TBDetDescrManager", m_TBDetDescrManager = "TBDetDescrMgr");
  declareProperty("TBElementContainer", m_TBElementContainer = "TBElementCnt");
  declareProperty("ReadAction",  m_readAction = -1);
  declareProperty("WriteAction", m_writeAction = 0);
}

◆ ~TBDetDescrLoader()

TBDetDescrLoader::~TBDetDescrLoader ( )

virtual

Definition at line 28 of file TBDetDescrLoader.cxx.

29{

30}

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 TBDetDescrLoader::execute ( )

overridevirtual

Definition at line 112 of file TBDetDescrLoader.cxx.

                                     {
  StatusCode sc;
 
  TBElementContainer* pTBElementContainer;
 
  switch (m_readAction) {
 
  case 0: // do nothing
    ATH_MSG_DEBUG( "readAction: do nothing" );
 
    // write to StoreGate only if we are not reading from it!
 
    switch (m_writeAction) {
 
    case 0: // do nothing
      ATH_MSG_DEBUG( "writeAction: do nothing" );
      break;
 
    case 1: // write once
      m_writeAction = 0; // don't do anything anymore
                         // but without break proceed to next case
      /* FALLTHROUGH */
 
    case 2: // write always
 
      ATH_MSG_DEBUG( "Action: write TBDetDescr to StoreGate" );
      
      pTBElementContainer = new TBElementContainer();
 
      c_TBDDM->getAll(pTBElementContainer);
      c_TBDDM->print(msg());
  
      sc=evtStore()->record(pTBElementContainer, m_TBElementContainer, false);
      if(sc.isFailure()) {
        ATH_MSG_FATAL( "failed to register the TBElementContainer" );
        return StatusCode::FAILURE;
      }
      break;
 
    default:
      break;
    }
 
    break;
 
  case 1: // read once
    m_readAction = 0; // don't do anything anymore
                      // but without break proceed to next case
    /* FALLTHROUGH */
 
  case 2: // read always
 
    ATH_MSG_DEBUG( "Action: read TBDetDescr from StoreGate" );
    {
      const TBElementContainer* pContainer = nullptr;
      ATH_CHECK( evtStore()->retrieve(pContainer,m_TBElementContainer) );
      m_TBDDM->initialize(pContainer);
      m_TBDDM->print(msg());
    }
    break;
      
  default:
    break;
 
  }
  
  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();
}

◆ finalize()

StatusCode TBDetDescrLoader::finalize ( )

overridevirtual

Definition at line 182 of file TBDetDescrLoader.cxx.

                           {
  ATH_MSG_INFO( "finalized successfully" );
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TBDetDescrLoader::initialize ( )

overridevirtual

Definition at line 33 of file TBDetDescrLoader.cxx.

{ 
  StatusCode sc;
 
  if (m_readAction != 0) {
 
    ATH_MSG_INFO( "Creating TBDetDescrManager in DetectorStore" );
 
    m_TBDDM = new TBDetDescrManager();
 
    // somebody else should provide coordinates for all envelopes
    // we can't do anything here 
    // so this initialization is not needed,
    // it is kept here as an example
    std::vector<TBElement> vec;
    vec.resize(1); // it will contain just one "Unknown" element
 
    // initialize the manager with detectors we just created
    m_TBDDM->initialize(vec);
    m_TBDDM->print(msg());
    
    if (m_readAction < 0) {
      m_readAction = 0;
      sc=detStore()->record(m_TBDDM, m_TBDetDescrManager, true);
    } else {
        sc=detStore()->record(m_TBDDM, m_TBDetDescrManager, false);
    }
    
    if(sc.isFailure()) {
      ATH_MSG_ERROR( "failed to register TBDetDescrManager in Detector Store" );
      m_readAction = 0;
      ATH_MSG_ERROR( "resetting m_readAction to 0" );
      delete m_TBDDM;
      // do not exit wih FAILURE here
      // probably manager is created already
      // and we just want to use it
      // return sc;
    }
  } else {
 
    CxxUtils::RefCountedPtr<DetDescrAddress> addr
      (new DetDescrAddress(
                           ClassID_traits<TBDetDescrManager>::ID(),
                           m_TBDetDescrManager, m_TBDetDescrManager));
 
    sc = detStore()->recordAddress(addr);
    if (sc != StatusCode::SUCCESS) {
      ATH_MSG_INFO( "unable to fill address for " << (*addr->par())
                    << " with CLID " << addr->clID()
                    << " and storage type " << addr->svcType()
                    << " to detector store " );
    }
    else {
      unsigned int st = addr->svcType();
      ATH_MSG_INFO( "filling address for " << (*addr->par())
                    << " with CLID " << addr->clID()
                    << " and storage type " << st
                    << " to detector store " );
    }
  }
  
  if (m_writeAction != 0) {
 
    ATH_MSG_INFO( "Retrieving TBDetDescrManager from DetectorStore" );
    
    sc = detStore()->retrieve(c_TBDDM);
    if (sc.isFailure()) {
      ATH_MSG_ERROR( "Unable to retrieve TBDetDescrManager from DetectorStore" );
      m_writeAction = 0;
      ATH_MSG_ERROR( "resetting m_writeAction to 0" );
      return StatusCode::RECOVERABLE;
    }
    c_TBDDM->print(msg());
  }
 
  ATH_MSG_INFO( "initialization completed" );
  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()

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.

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

Member Data Documentation

◆ c_TBDDM

const TBDetDescrManager* TBDetDescrLoader::c_TBDDM

private

Definition at line 35 of file TBDetDescrLoader.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_readAction

int TBDetDescrLoader::m_readAction

private

Definition at line 31 of file TBDetDescrLoader.h.

◆ m_TBDDM

TBDetDescrManager* TBDetDescrLoader::m_TBDDM

private

Definition at line 34 of file TBDetDescrLoader.h.

◆ m_TBDetDescrManager

std::string TBDetDescrLoader::m_TBDetDescrManager

private

Definition at line 29 of file TBDetDescrLoader.h.

◆ m_TBElementContainer

std::string TBDetDescrLoader::m_TBElementContainer

private

Definition at line 30 of file TBDetDescrLoader.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.

◆ m_writeAction

int TBDetDescrLoader::m_writeAction

private

Definition at line 32 of file TBDetDescrLoader.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TBDetDescrLoader()

◆ ~TBDetDescrLoader()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ c_TBDDM

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_readAction

◆ m_TBDDM

◆ m_TBDetDescrManager

◆ m_TBElementContainer

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeAction