TrkEDMTestAlg Class Reference

#include <TrkEDMTestAlg.h>

Inheritance diagram for TrkEDMTestAlg:

Collaboration diagram for TrkEDMTestAlg:

Public Member Functions
	TrkEDMTestAlg (const std::string &name, ISvcLocator *pSvcLocator)
	~TrkEDMTestAlg ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
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
virtual StatusCode	runTest ()=0
template<class T>
void	loadAndDumpContainer (const std::string &collectionName, std::ofstream &stream)
	load container of objects, and dump each contained object to MsgStream, and or external file (depending on jobOpts)
template<class T>
void	loadAndDumpIdentifiableContainer (const std::string &collectionName, std::ofstream &stream)
template<class T>
void	loadAndDumpMultipleContainers (std::vector< std::string > &collectionNames, std::ofstream &stream)
	load container of objects, and dump each contained object to MsgStream, and or external file (depending on jobOpts)
template<class T>
unsigned int	dumpAndTestElements (const T *container, std::ofstream &stream)
template<class COLLECTION>
void	checkPRDCollectionValidity (const COLLECTION &coll)
template<class PRD, class IDHELPER, class COLLECTION>
void	checkPRD (const PRD *prd, const IDHELPER *helper, const COLLECTION &coll)
template<class PRD>
std::pair< const Trk::TrkDetElementBase *, const Trk::TrkDetElementBase * >	getReadoutElements (const PRD *prd) const
template<class IDHELPER, class PRD>
bool	testDetectorElement (IdentifierHash idhash, const IDHELPER *helper, const PRD *prd) const
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
unsigned int	m_eventNum
	numbers of event
bool	m_dumpToMsg
bool	m_dumpToFile
bool	m_dumpSummaryToFile
std::string	m_summaryDumpFileName
std::ofstream	m_summaryFileOutput
bool	m_doDetailedChecks
	If true, try to examine the PRDs etc in detail and catch any errors.
unsigned int	m_numDetailedWarnings
	Count of detailed warning found.
std::map< std::string, unsigned int >	m_numContsFound
std::map< std::string, unsigned int >	m_numConstObjsFound

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
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 23 of file TrkEDMTestAlg.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

TrkEDMTestAlg()

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

Definition at line 8 of file TrkEDMTestAlg.cxx.

:
  AthAlgorithm(name, pSvcLocator),
  m_eventNum(0),
  m_numDetailedWarnings(0)
{
  declareProperty("DoDumpSummaryToFile",           m_dumpSummaryToFile=true);
  declareProperty("SummaryDumpFileName",           m_summaryDumpFileName="TrkEDMTestAlg.summary.log");
  declareProperty("DoDumpToFile",                  m_dumpToFile=true);
  declareProperty("DoDumpToMsgStream",             m_dumpToMsg=false);
  declareProperty("DoDetailedChecks",              m_doDetailedChecks=false);
}

~TrkEDMTestAlg()

TrkEDMTestAlg::~TrkEDMTestAlg ( )

default

Member Function Documentation

checkPRD()

template<class PRD, class IDHELPER, class COLLECTION>

void TrkEDMTestAlg::checkPRD ( const PRD * prd, const IDHELPER * helper, const COLLECTION & coll )

protected

checkPRDCollectionValidity()

template<class COLLECTION>

void TrkEDMTestAlg::checkPRDCollectionValidity ( const COLLECTION & coll )

protected

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.

{ return m_detStore; }

dumpAndTestElements()

template<class T>

unsigned int TrkEDMTestAlg::dumpAndTestElements ( const T * container, std::ofstream & stream )

protected

Definition at line 168 of file TrkEDMTestAlg.h.

{ 
  unsigned int numConsituents=0;
 
  typename T::const_iterator element     = container->begin(); 
  typename T::const_iterator lastElement = container->end();
 
  for ( ; element!=lastElement ; ++element) {
    if (*element!=0){
      ++numConsituents;
      // dumping collections
      if (m_dumpToFile)
    stream << std::setprecision(6) << **element<<std::endl;
      if (m_dumpToMsg) 
    ATH_MSG_VERBOSE(**element);
    }else{
      if (m_dumpToFile)
    stream<<"WARNING! Zero pointer!"<<std::endl;
      if (m_dumpToMsg) 
    ATH_MSG_WARNING("Zero pointer!");
    }    
  }
  return numConsituents;
}

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.

{ return m_evtStore; }

execute()

StatusCode TrkEDMTestAlg::execute

(

)

Definition at line 40 of file TrkEDMTestAlg.cxx.

{
  ++m_eventNum;
  return runTest();
}

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 TrkEDMTestAlg::finalize

(

)

Definition at line 49 of file TrkEDMTestAlg.cxx.

{
  ATH_MSG_INFO("Number of events processed = "<<m_eventNum);
  if (m_numDetailedWarnings>0) ATH_MSG_ERROR(" Found "<<m_numDetailedWarnings<<" problems! Please check log for more details.");
 
  if (m_dumpSummaryToFile) m_summaryFileOutput  <<"Summary"<<std::endl<<"-------"<<std::endl;
 
  for (const auto & [SGKey, objCount] : m_numContsFound ) {
    const int numberOfObjects = m_numConstObjsFound[SGKey];
    ATH_MSG_INFO("Found :"<<objCount<<" \t at "<<SGKey<<", with "<<numberOfObjects<<" total contained objects.");
    if (m_dumpSummaryToFile){
      m_summaryFileOutput <<"Found :"<<objCount<<" \t at "<<SGKey<<", with "<<numberOfObjects<<" total contained objects."<<std::endl;
    } 
  }
  if (m_dumpSummaryToFile){
    if (m_doDetailedChecks) m_summaryFileOutput<<"Detailed tests found : "<<m_numDetailedWarnings<<" problems.";
    m_summaryFileOutput.close();
  }
 
  return StatusCode::SUCCESS;
}

getReadoutElements()

template<class PRD>

std::pair< const Trk::TrkDetElementBase *, const Trk::TrkDetElementBase * > TrkEDMTestAlg::getReadoutElements ( const PRD * prd ) const

protected

initialize()

StatusCode TrkEDMTestAlg::initialize

(

)

Definition at line 27 of file TrkEDMTestAlg.cxx.

{
  // summary is special (normally want to write it)
  if (m_dumpSummaryToFile) {
    m_summaryFileOutput.open(m_summaryDumpFileName.c_str());
    ATH_MSG_VERBOSE("SUM dump="<<m_summaryDumpFileName);
  }
 
  return AthAlgorithm::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.

loadAndDumpContainer()

template<class T>

void TrkEDMTestAlg::loadAndDumpContainer ( const std::string & collectionName, std::ofstream & stream )

protected

load container of objects, and dump each contained object to MsgStream, and or external file (depending on jobOpts)

Definition at line 122 of file TrkEDMTestAlg.h.

{
  using namespace std;    
  const T* container;
  if (!evtStore()->contains<T>(containerName)) return;
  if (evtStore()->retrieve(container, containerName).isSuccess())    {
    if (m_dumpToFile)
      stream  <<"Found container "<<containerName<<", which has "<<container->size()
          <<" elements (see below)."<<std::endl;
    if (m_dumpToMsg) 
      ATH_MSG_VERBOSE("Found container "<<containerName<<", which has "<<container->size()
              <<" elements (see below).");
  
    m_numContsFound[containerName]++; // increment counter.
    m_numConstObjsFound[containerName]+=container->size(); // increment counter.
    unsigned int totalConsituents = dumpAndTestElements(container, stream);
    if (m_dumpToFile)
      stream<<"Found "<<totalConsituents<<" constituent objects. (size was reported as "<<container->size()<<")"<<std::endl;
    if (m_dumpToMsg) 
      ATH_MSG_VERBOSE("Found "<<totalConsituents<<" constituent objects.(size was reported as "<<container->size()<<")");
  }else{
    if (m_dumpToFile)
      stream<<"WARNING! Could not find container: "<<containerName<<"!"<<std::endl;
    if (m_dumpToMsg) 
      ATH_MSG_WARNING("Could not find container: "<<containerName<<"!");
  }
  return;        
}    

loadAndDumpIdentifiableContainer()

template<class T>

void TrkEDMTestAlg::loadAndDumpIdentifiableContainer ( const std::string & collectionName, std::ofstream & stream )

protected

Definition at line 85 of file TrkEDMTestAlg.h.

{
  using namespace std;    
 
  const T* container;
  if (!evtStore()->contains<T>(containerName)) return;
  StatusCode sc = evtStore()->retrieve(container, containerName);
  if (sc.isSuccess())
    {
      typename T::const_iterator::const_iterator element     = container->begin(); 
      typename T::const_iterator::const_iterator lastElement = container->end();
      if (m_dumpToFile)
    stream  <<"Found container "<<containerName<<", which has "<<container->numberOfCollections()<<" collections (see below)."<<std::endl;
      if (m_dumpToMsg) 
    ATH_MSG_VERBOSE("Found container "<<containerName<<", which has "<<container->numberOfCollections()<<" collections (see below).");   
 
      m_numContsFound[containerName]++; // increment counter.
 
      unsigned int totalConsituents = dumpAndTestElements(container, stream);
 
      if (m_dumpToFile)
    stream<<"Found "<<totalConsituents<<" constituent objects."<<std::endl;
      if (m_dumpToMsg) 
    ATH_MSG_VERBOSE("Found "<<totalConsituents<<" constituent objects.");
      m_numConstObjsFound[containerName]+=totalConsituents; // increment counter.
    }else{
    if (m_dumpToFile)
      stream<<"WARNING! Could not find container: "<<containerName<<"!"<<std::endl;
    if (m_dumpToMsg) 
      ATH_MSG_WARNING("Could not find container: "<<containerName<<"!");
  }
 
  return;        
}    

loadAndDumpMultipleContainers()

template<class T>

void TrkEDMTestAlg::loadAndDumpMultipleContainers ( std::vector< std::string > & collectionNames, std::ofstream & stream )

protected

load container of objects, and dump each contained object to MsgStream, and or external file (depending on jobOpts)

Definition at line 154 of file TrkEDMTestAlg.h.

{
  using namespace std;    
  //loads tracks
  for (vector<string>::const_iterator it=containerNames.begin(); it!=containerNames.end() ; ++it)
    {
      const std::string& containerLoc = *it;
      loadAndDumpContainer<T>( containerLoc, stream );
    }
  return;
}    

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

runTest()

virtual StatusCode TrkEDMTestAlg::runTest ( )

protectedpure virtual

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.

testDetectorElement()

template<class IDHELPER, class PRD>

bool TrkEDMTestAlg::testDetectorElement ( IdentifierHash idhash, const IDHELPER * helper, const PRD * prd ) const

protected

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_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_doDetailedChecks

bool TrkEDMTestAlg::m_doDetailedChecks

protected

If true, try to examine the PRDs etc in detail and catch any errors.

Will take more time.

Definition at line 71 of file TrkEDMTestAlg.h.

m_dumpSummaryToFile

bool TrkEDMTestAlg::m_dumpSummaryToFile

protected

Definition at line 66 of file TrkEDMTestAlg.h.

m_dumpToFile

bool TrkEDMTestAlg::m_dumpToFile

protected

Definition at line 65 of file TrkEDMTestAlg.h.

m_dumpToMsg

bool TrkEDMTestAlg::m_dumpToMsg

protected

Definition at line 64 of file TrkEDMTestAlg.h.

m_eventNum

unsigned int TrkEDMTestAlg::m_eventNum

protected

numbers of event

Definition at line 62 of file TrkEDMTestAlg.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_numConstObjsFound

std::map<std::string, unsigned int> TrkEDMTestAlg::m_numConstObjsFound

protected

Definition at line 78 of file TrkEDMTestAlg.h.

m_numContsFound

std::map<std::string, unsigned int> TrkEDMTestAlg::m_numContsFound

protected

Definition at line 75 of file TrkEDMTestAlg.h.

m_numDetailedWarnings

unsigned int TrkEDMTestAlg::m_numDetailedWarnings

protected

Count of detailed warning found.

Definition at line 72 of file TrkEDMTestAlg.h.

m_summaryDumpFileName

std::string TrkEDMTestAlg::m_summaryDumpFileName

protected

Definition at line 68 of file TrkEDMTestAlg.h.

m_summaryFileOutput

std::ofstream TrkEDMTestAlg::m_summaryFileOutput

protected

Definition at line 69 of file TrkEDMTestAlg.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:

• TrkEDMTestAlg.h
• TrkEDMTestAlg.cxx