Small algorith, which traverses the data store and prints generic information about all leaves, which can be loaded/accessed. More...

Inheritance diagram for StoreExplorerAlg:

[legend]

Collaboration diagram for StoreExplorerAlg:

[legend]

Public Member Functions
	StoreExplorerAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Standard algorithm constructor. More...

	~StoreExplorerAlg () override=default
	Standard Destructor. More...

template<class T >
std::string	access (T *p)

void	printObj (IRegistry *pReg, std::vector< bool > &flg)
	Print datastore leaf. More...

void	explore (IRegistry *pObj, std::vector< bool > &flg)

StatusCode	initialize () override
	Initialize. More...

StatusCode	finalize () override
	Finalize. More...

StatusCode	execute () override
	Execute procedure. More...

Public Member Functions inherited from Algorithm
	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...

	~Algorithm () override=default
	Destructor. More...

StatusCode	sysStart () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysRestart () override
	Restart method invoked by the framework. More...

StatusCode	sysExecute () override
	The actions to be performed by the algorithm on an event. More...

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...

StatusCode	sysEndRun () override
	endRun method invoked by the framework. More...

const std::string &	name () const override
	The identifying name of the algorithm object. More...

const Gaudi::StringKey &	nameKey () const override

const std::string &	type () const override
	The type of the algorithm object. More...

void	setType (const std::string &type) override

const std::string &	version () const override

unsigned int	index () const override

StatusCode	configure () override
	Dummy implementation of IStateful::configure() method. More...

StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method. More...

StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method More...

StatusCode	start () override
	the default (empty) implementation of IStateful::start() method More...

StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method More...

StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method More...

StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method More...

StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method More...

Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm More...

Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition More...

bool	isExecuted () const override
	Has this algorithm been executed since the last reset? More...

void	setExecuted (bool state) override
	Set the executed flag to the specified state. More...

void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...

StatusCode	beginRun () override
	Algorithm begin run. More...

StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...

bool	isEnabled () const override
	Is this algorithm enabled or disabled? More...

bool	filterPassed () const override
	Did this algorithm pass or fail its filter criterion for the last event? More...

void	setFilterPassed (bool state) override
	Set the filter passed flag to the specified state. More...

int	errorCount () const
	Get the number of failures of the algorithm. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

template<class T >
SmartIF< T >	service (const std::string &name, bool createIf=true, bool quiet=false) const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...

SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...

SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...

SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...

SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...

SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...

SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...

SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...

SmartIF< ITimelineSvc > &	timelineSvc () const

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...

SmartIF< IHiveWhiteBoard > &	whiteboard () const

bool	registerContext () const
	register for Algorithm Context Service? More...

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

StatusCode	setProperty (const Property &p) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...

StatusCode	getProperty (Property *p) const override
	Implementation of IProperty::getProperty. More...

const Property &	getProperty (const std::string &name) const override
	Implementation of IProperty::getProperty. More...

StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const override
	Implementation of IProperty::getProperties. More...

bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...

PropertyMgr *	getPropertyMgr ()

StatusCode	setProperties ()
	Set the algorithm's properties. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

template<class T >
Property *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none") const

template<class T >
Property *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none") const

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

EventContext *	getContext () const
	get the context More...

void	setContext (EventContext *context)
	set the context More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

virtual void	acceptDHVisitor (IDataHandleVisitor *) const override

const DataObjIDColl &	inputDataObjs () const

const DataObjIDColl &	outputDataObjs () const

void	commitHandles () override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)

const std::vector< IAlgTool * > &	tools () const

bool	isClonable () const override
	Specifies the clonability of the algorithm. More...

unsigned int	cardinality () const override
	Return the cardinality. More...

const std::vector< std::string > &	neededResources () const override

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Attributes
long	m_print
	Job option to limit printout to first nnn events. More...

double	m_frequency
	Job option to set the printout frequency. More...

bool	m_exploreRelations
	Flag to check if relations should be followed. More...

long	m_printMissing
	Flag to indicate if missing entities should be printed. More...

long	m_total = 0
	Internal counter to trigger printouts. More...

long	m_frqPrint = 0
	Internal counter to adjust printout frequency. More...

bool	m_load
	Flag to load non existing items. More...

bool	m_testAccess
	Flag to test access to objects (DataObject and ContainedObject) More...

bool	m_accessForeign
	Flag to indicate if foreign files should be opened. More...

SmartIF< IDataProviderSvc >	m_dataSvc
	Reference to data provider service. More...

std::string	m_dataSvcName
	Name of the data provider service. More...

std::string	m_rootName
	Name of the root leaf (obtained at initialize) More...

Additional Inherited Members
Public Types inherited from Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using	base_class = CommonMessaging

Protected Member Functions inherited from Algorithm
virtual void	declareInput (Gaudi::DataHandle *im) override

virtual void	declareOutput (Gaudi::DataHandle *im) override

std::vector< IAlgTool * > &	tools ()

bool	isInitialized () const override
	Has the Algorithm already been initialized? More...

bool	isFinalized () const override
	Has the Algorithm already been finalized? More...

void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg More...

Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Algorithm
EventContext *	m_event_context
	Event specific data for multiple event processing. More...

SmartIF< PropertyMgr >	m_propertyMgr
	For management of properties. More...

std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles. More...

Detailed Description

Small algorith, which traverses the data store and prints generic information about all leaves, which can be loaded/accessed.

Author: : M.Frank

Version: : 1.0

Definition at line 30 of file StoreExplorerAlg.cpp.

Constructor & Destructor Documentation

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

inline

Standard algorithm constructor.

Definition at line 58 of file StoreExplorerAlg.cpp.

   : Algorithm(name, pSvcLocator)
   {
     declareProperty("Load",             m_load = false);
     declareProperty("PrintEvt",         m_print = 1);
     declareProperty("PrintMissing",     m_printMissing = 0);
     declareProperty("PrintFreq",        m_frequency = 0.0);
     declareProperty("ExploreRelations", m_exploreRelations = false);
     declareProperty("DataSvc",          m_dataSvcName="EventDataSvc");
     declareProperty("TestAccess",       m_testAccess = false);
     declareProperty("AccessForeign",    m_accessForeign = false);
   }

StoreExplorerAlg::~StoreExplorerAlg ( )

overridedefault

Standard Destructor.

Member Function Documentation

template<class T >

std::string StoreExplorerAlg::access ( T * p )

inline

Definition at line 74 of file StoreExplorerAlg.cpp.

                           {
     if ( !p )  return "Access FAILED.";
     std::string result = std::accumulate(std::begin(*p),std::end(*p),std::string{},
                                          [&](std::string s,typename T::const_reference i) {
         return s+std::to_string(p->index(i)) + ":" + std::to_string(i->clID()) + ",";
     });
     return result.substr(0, result.length()-2);
   }

StatusCode StoreExplorerAlg::execute ( )

inlineoverride

Execute procedure.

Definition at line 215 of file StoreExplorerAlg.cpp.

                                 {
     SmartDataPtr<DataObject>   root(m_dataSvc.get(),m_rootName);
     if ( ((m_print > m_total++) || (m_frequency*m_total > m_frqPrint)) && root )    {
       if ( m_frequency*m_total > m_frqPrint )  m_frqPrint++;
       std::string store_name = "Unknown";
       IRegistry* pReg = root->registry();
       if ( pReg )  {
         auto isvc = SmartIF<IService>{pReg->dataSvc()};
         if ( isvc )  store_name = isvc->name();
       }
       info() << "========= " << m_rootName << "["
           << std::showbase << std::hex << (unsigned long) root.ptr() << std::dec
           << "@" << store_name << "]:" << endmsg;
       std::vector<bool> flg(1,true);
       explore(root->registry(), flg);
       return StatusCode::SUCCESS;
     } else if ( root )   {
       return StatusCode::SUCCESS;
     }
     error() << "Cannot retrieve \"/Event\"!" << endmsg;
     return StatusCode::FAILURE;
   }

void StoreExplorerAlg::explore	(	IRegistry *	pObj,
		std::vector< bool > &	flg
	)

inline

Definition at line 149 of file StoreExplorerAlg.cpp.

                                                          {
     printObj(pObj, flg);
     if ( pObj )    {
       auto mgr = eventSvc().as<IDataManagerSvc>();
       if ( mgr )    {
         std::vector<IRegistry*> leaves;
         StatusCode sc = mgr->objectLeaves(pObj, leaves);
         const std::string* par0 = nullptr;
         if ( pObj->address() )  par0 = pObj->address()->par();
         if ( sc.isSuccess() )  {
           for ( auto i=leaves.begin(); i != leaves.end(); i++ )   {
             const std::string& id = (*i)->identifier();
             DataObject* p = nullptr;
             if ( !m_accessForeign && (*i)->address() )  {
               if ( par0 )  {
                 const std::string* par1 = (*i)->address()->par();
                 if ( par1 &&  par0[0] != par1[0] )  continue;
               }
             }
             if ( m_load )  {
               sc = eventSvc()->retrieveObject(id, p);
             } else {
               sc = eventSvc()->findObject(id, p);
             }
             if ( sc.isSuccess() )  {
               if ( id != "/Event/Rec/Relations" || m_exploreRelations )   {
                 flg.push_back(i+1 == leaves.end());
                 explore(*i, flg);
                 flg.pop_back();
               }
             } else {
               flg.push_back(i+1 == leaves.end());
               printObj(*i, flg);
               flg.pop_back();
             }
           }
         }
       }
     }
   }

StatusCode StoreExplorerAlg::finalize ( )

inlineoverride

Finalize.

Definition at line 209 of file StoreExplorerAlg.cpp.

                                  {
     m_dataSvc.reset();
     return StatusCode::SUCCESS;
   }

StatusCode StoreExplorerAlg::initialize ( )

inlineoverride

Initialize.

Definition at line 191 of file StoreExplorerAlg.cpp.

                                      {
     m_rootName.clear();
     m_dataSvc = service(m_dataSvcName,true);
     if ( !m_dataSvc )  {
         error() << "Failed to access service \""
             << m_dataSvcName << "\"." << endmsg;
         return StatusCode::FAILURE;
     }
     auto mgr = m_dataSvc.as<IDataManagerSvc>();
     if ( !mgr )  {
         error() << "Failed to retrieve IDataManagerSvc interface." << endmsg;
         return StatusCode::FAILURE;
     }
     m_rootName = mgr->rootName();
     return StatusCode::SUCCESS;
   }

void StoreExplorerAlg::printObj	(	IRegistry *	pReg,
		std::vector< bool > &	flg
	)

inline

Print datastore leaf.

Definition at line 85 of file StoreExplorerAlg.cpp.

                                                           {
     auto& log = info();
     for (size_t j = 1; j < flg.size(); j++ )     {
       if ( !flg[j-1] && flg[j] ) log << "| ";
       else if ( flg[j] ) log << "  ";
       else          log << "| ";
     }
     log << "+--> " << pReg->name();
     if ( pReg->address() )  {
       log << " [Address: CLID="
           << std::showbase << std::hex << pReg->address()->clID()
           << " Type=" << (void*)pReg->address()->svcType() << "]";
     }
     else  {
       log << " [No Address]";
     }
     DataObject* p = pReg->object();
     if ( p )   {
       try  {
         std::string typ = System::typeinfoName(typeid(*p));
         if ( m_testAccess )  p->clID();
         log << "  " << typ.substr(0,32);
       }
       catch (...)  {
         log << "Access test FAILED";
       }
     }
     else    {
       log << "  (Unloaded) ";
     }
     ObjectContainerBase* base = dynamic_cast<ObjectContainerBase*>(p);
     if ( base )  {
       try   {
         int numObj = base->numberOfObjects();
         const CLID id = p->clID();
         log << " [" << numObj << "]";
         if ( m_testAccess )  {
           CLID idd = id>>16;
           switch(idd) {
             case CLID_ObjectList>>16:                /* ObjectList    */
               access((ObjectList<ContainedObject>*)base);
               break;
             case CLID_ObjectVector>>16:              /* ObjectVector  */
               access((ObjectVector<ContainedObject>*)base);
               break;
             case (CLID_ObjectVector+0x00030000)>>16: /* Keyed Map     */
               access((KeyedContainer<KeyedObject<int>,Containers::Map>*)base);
               break;
             case (CLID_ObjectVector+0x00040000)>>16: /* Keyed Hashmap */
               access((KeyedContainer<KeyedObject<int>,Containers::HashMap>*)base);
               break;
             case (CLID_ObjectVector+0x00050000)>>16: /* Keyed array   */
               access((KeyedContainer<KeyedObject<int>,Containers::Array>*)base);
               break;
           }
         }
       }
       catch (...)  {
         log << "Access test FAILED";
       }
     }
     log << endmsg;
   }

Member Data Documentation

bool StoreExplorerAlg::m_accessForeign

private

Flag to indicate if foreign files should be opened.

Definition at line 48 of file StoreExplorerAlg.cpp.

SmartIF<IDataProviderSvc> StoreExplorerAlg::m_dataSvc

private

Reference to data provider service.

Definition at line 50 of file StoreExplorerAlg.cpp.

std::string StoreExplorerAlg::m_dataSvcName

private

Name of the data provider service.

Definition at line 52 of file StoreExplorerAlg.cpp.

bool StoreExplorerAlg::m_exploreRelations

private

Flag to check if relations should be followed.

Definition at line 36 of file StoreExplorerAlg.cpp.

double StoreExplorerAlg::m_frequency

private

Job option to set the printout frequency.

Definition at line 34 of file StoreExplorerAlg.cpp.

long StoreExplorerAlg::m_frqPrint = 0

private

Internal counter to adjust printout frequency.

Definition at line 42 of file StoreExplorerAlg.cpp.

bool StoreExplorerAlg::m_load

private

Flag to load non existing items.

Definition at line 44 of file StoreExplorerAlg.cpp.

long StoreExplorerAlg::m_print

private

Job option to limit printout to first nnn events.

Definition at line 32 of file StoreExplorerAlg.cpp.

long StoreExplorerAlg::m_printMissing

private

Flag to indicate if missing entities should be printed.

Definition at line 38 of file StoreExplorerAlg.cpp.

std::string StoreExplorerAlg::m_rootName

private

Name of the root leaf (obtained at initialize)

Definition at line 54 of file StoreExplorerAlg.cpp.

bool StoreExplorerAlg::m_testAccess

private

Flag to test access to objects (DataObject and ContainedObject)

Definition at line 46 of file StoreExplorerAlg.cpp.

long StoreExplorerAlg::m_total = 0

private

Internal counter to trigger printouts.

Definition at line 40 of file StoreExplorerAlg.cpp.

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

GaudiCommonSvc/src/DataSvc/StoreExplorerAlg.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation