Test Algorithm for POOL I/O uses CaloCellContainer as test data. More...

#include <LArCellContFakeReader.h>

Inheritance diagram for LArCellContFakeReader:

Collaboration diagram for LArCellContFakeReader:

Public Member Functions
	LArCellContFakeReader (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor.
virtual StatusCode	initialize () override
	Algorithm initialize at begin of job.
virtual StatusCode	execute () override
	Algorithm execute once per event.
virtual StatusCode	finalize () override
	Algorithm finalize at end of job.
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
	LArCellContFakeReader ()
	Avoid use of default constructor.
	LArCellContFakeReader (const LArCellContFakeReader &)
	Avoid use of copy constructor.
LArCellContFakeReader &	operator= (const LArCellContFakeReader &)
	Avoid use of copy operator.
void	printCells (const CaloCellContainer *larCont) const
	Print out cell info.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey
	Need DD mgr to create cells.
const CaloCell_ID *	m_calocellId
	Need id helper to create cells.
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

Test Algorithm for POOL I/O uses CaloCellContainer as test data.

Definition at line 37 of file LArCellContFakeReader.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

◆ LArCellContFakeReader() [1/3]

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

Algorithm constructor.

Definition at line 28 of file LArCellContFakeReader.cxx.

                                                   :
    AthAlgorithm(name,pSvcLocator),
    m_calocellId(nullptr)
{}

◆ LArCellContFakeReader() [2/3]

LArCellContFakeReader::LArCellContFakeReader ( )

private

Avoid use of default constructor.

◆ LArCellContFakeReader() [3/3]

LArCellContFakeReader::LArCellContFakeReader ( const LArCellContFakeReader & )

private

Avoid use of copy constructor.

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

overridevirtual

Algorithm execute once per event.

Definition at line 44 of file LArCellContFakeReader.cxx.

{
    ATH_MSG_DEBUG("LArCellContFakeReader::execute()" );
 
    SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey};
    ATH_CHECK(caloMgrHandle.isValid());
 
    // Retrieve container
    const CaloCellContainer* caloCont = nullptr;
    ATH_CHECK( evtStore()->retrieve(caloCont,"CaloCellCont1") );
    ATH_MSG_DEBUG( "Container '" << "CaloCellCont"
                   << "' retrieved from StoreGate"  );
 
    LArCellContFakeCreator creator;
 
    // Create container
    MsgStream log(msgSvc(), name());
    const CaloCellContainer* caloCont1 = creator.createCaloCellContainer(m_calocellId,
                                     *caloMgrHandle,
                                     msg());
 
    CaloCellContainer::const_iterator first = caloCont->begin();
    CaloCellContainer::const_iterator last  = caloCont->end();
    CaloCellContainer::const_iterator first1 = caloCont1->begin();
    CaloCellContainer::const_iterator last1  = caloCont1->end();
    
    bool error = false;
    int ncells = 0;
    int ncellErrs = 0;
    
    for(; first != last && first1 != last1; ++first, ++first1) {
    if (((*first)->ID()    !=  (*first1)->ID()) ||
        (fabs((*first)->energy()  - (*first1)->energy()  ) > 0.01*fabs((*first)->energy())) || 
        (fabs((*first)->time()    - (*first1)->time()    ) > 0.0002*fabs((*first)->time())) || 
        (std::abs((*first)->quality() - (*first1)->quality() ) > 0) || 
        (std::abs((*first)->provenance() - (*first1)->provenance() ) > 0) || 
        (fabs((*first)->eta()     - (*first1)->eta()     ) > 0.0000001) || 
        (fabs((*first)->phi()     - (*first1)->phi()     ) > 0.0000001)) {
        ATH_MSG_ERROR("CaloCell1,2 differ: id "
        << m_calocellId->show_to_string((*first)->ID())
        << m_calocellId->show_to_string((*first1)->ID())
        << " energy  " << (*first)->energy() << " "
        << (*first1)->energy() 
        << " time    " << (*first)->time() << " "
        << (*first1)->time()
        << " quality " << (*first)->quality() << " "
        << (*first1)->quality() 
        << " provenance " << (*first)->provenance() << " "
        << (*first1)->provenance() 
        << " eta     " << (*first)->eta() << " "
        << (*first1)->eta() 
        << " phi     " << (*first)->phi() << " "
        << (*first1)->phi());
        error = true;
        ncellErrs++;
    }
    ncells++;
    }
 
    printCells(caloCont);
 
    if (error) {
    ATH_MSG_ERROR("Errors: " << ncellErrs );
    return StatusCode::FAILURE;
    }
    else {
    ATH_MSG_INFO("Successful check of CaloCellContainer I/O. Cells read: " << ncells );
    }
    
    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 LArCellContFakeReader::finalize ( )

overridevirtual

Algorithm finalize at end of job.

Definition at line 147 of file LArCellContFakeReader.cxx.

{
    ATH_MSG_INFO("LArCellContFakeReader::finalize()" );
 
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode LArCellContFakeReader::initialize ( )

overridevirtual

Algorithm initialize at begin of job.

Definition at line 35 of file LArCellContFakeReader.cxx.

{
    ATH_MSG_INFO( "LArCellContFakeReader::initialize()"  );
    ATH_CHECK( detStore()->retrieve(m_calocellId, "CaloCell_ID") );
    ATH_CHECK(m_caloMgrKey.initialize());
    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);
  }

◆ operator=()

LArCellContFakeReader & LArCellContFakeReader::operator= ( const LArCellContFakeReader & )

private

Avoid use of copy operator.

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

◆ printCells()

void LArCellContFakeReader::printCells ( const CaloCellContainer * larCont ) const

private

Print out cell info.

Definition at line 117 of file LArCellContFakeReader.cxx.

{
 
    ATH_MSG_INFO("LArCellContFakeReader::printRDOs()" );
 
    // loop on all cells
 
    CaloCellContainer::const_iterator first = caloCont->begin();
    CaloCellContainer::const_iterator last  = caloCont->end();
    
    for(; first != last; ++first) {
    
    ATH_MSG_INFO("CaloCell: id "
        << m_calocellId->show_to_string((*first)->ID())
        << std::setprecision(5)
        << " energy  " << (*first)->energy()
        << " time    " << (*first)->time()
        << " quality " << (*first)->quality()
        << " provenance " << (*first)->provenance()
        << " eta     " << (*first)->eta()
        << " phi     " << (*first)->phi()
        );
    }
    
    ATH_MSG_DEBUG("LArCellContFakeReader::printCells() end" );
 
}

◆ 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

◆ m_calocellId

const CaloCell_ID* LArCellContFakeReader::m_calocellId

private

Need id helper to create cells.

Definition at line 81 of file LArCellContFakeReader.h.

◆ m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> LArCellContFakeReader::m_caloMgrKey

private

Initial value:

{ this
    , "CaloDetDescrManager"
    , "CaloDetDescrManager"
    , "SG Key for CaloDetDescrManager in the Condition Store" }

Need DD mgr to create cells.

Definition at line 75 of file LArCellContFakeReader.h.

                                                          { this
    , "CaloDetDescrManager"
    , "CaloDetDescrManager"
    , "SG Key for CaloDetDescrManager in the Condition Store" };

◆ 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_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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArCellContFakeReader() [1/3]

◆ LArCellContFakeReader() [2/3]

◆ LArCellContFakeReader() [3/3]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ operator=()

◆ outputHandles()

◆ printCells()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_calocellId

◆ m_caloMgrKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_varHandleArraysDeclared

◆ m_vhka