Tool to scan a transient store branch that collects all the objects that belong to the same source (file). More...

Inheritance diagram for DataSvcFileEntriesTool:

Collaboration diagram for DataSvcFileEntriesTool:

Public Member Functions
	DataSvcFileEntriesTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...

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

StatusCode	initialize () override
	Initialize the tool. More...

StatusCode	finalize () override
	Finalize the tool. More...

const LeavesList &	leaves () const override
	Return the list of collected objects. More...

void	handle (const Incident &incident) override
	Call-back function for the BeginEvent incident. More...

Public Member Functions inherited from extends< AlgTool, IDataStoreLeaves, IIncidentListener >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from AlgTool
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface. More...

const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object. More...

const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool. More...

const IInterface *	parent () const override
	Retrieve parent of the sub-algtool. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

StatusCode	reinitialize () override

StatusCode	restart () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	sysInitialize () override
	Initialize AlgTool. More...

StatusCode	sysStart () override
	Start AlgTool. More...

StatusCode	sysStop () override
	Stop AlgTool. More...

StatusCode	sysFinalize () override
	Finalize AlgTool. More...

StatusCode	sysReinitialize () override
	Initialize AlgTool. More...

StatusCode	sysRestart () override
	Start AlgTool. More...

StatusCode	setProperty (const Property &p) override
	Default implementations for IProperty interface. More...

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

PropertyMgr *	getPropertyMgr () const

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

	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...

IDataProviderSvc *	evtSvc () const
	accessor to event service service More...

IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...

template<class T >
StatusCode	service (const std::string &name, T *&svc, 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 &type, const std::string &name, T *&svc) const
	Access a service by name, 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<typename T >
SmartIF< T >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const

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 >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)

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

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

DataObjIDColl	inputDataObjs () const

DataObjIDColl	outputDataObjs () const

void	commitHandles () override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used public tool. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used private tool. More...

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

IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...

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

	~AlgTool () 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...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
void	i_collectLeaves ()
	Scan the data service starting from the node specified as Root. More...

void	i_collectLeaves (IRegistry *reg)
	Scan the data service starting from the specified node. More...

IRegistry *	i_getRootNode ()
	Return the pointer to the IRegistry object associated to the node specified as Root. More...

Private Attributes
std::string	m_dataSvcName
	Variable for the property DataService. More...

std::string	m_rootNode
	Variable for the property Root. More...

bool	m_scanOnBeginEvent
	Variable for the property ScanOnBeginEvent. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service. More...

SmartIF< IDataManagerSvc >	m_dataMgrSvc
	Pointer to the IDataManagerSvc interface of the data service. More...

SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to the IDataProviderSvc interface of the data service. More...

LeavesList	m_leaves
	Internal cache for the list of objects found during the scan. More...

std::string	m_initialBase
	File ID of the Root node. More...

bool	m_ignoreOriginChange
	Variable for the property ScanOnBeginEvent. More...

Additional Inherited Members
Public Types inherited from extends< AlgTool, IDataStoreLeaves, IIncidentListener >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

Public Types inherited from AlgTool
typedef Gaudi::PluginService::Factory< IAlgTool , const std::string &, const std::string &, const IInterface >	Factory

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

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Protected Member Functions inherited from AlgTool
template<typename I >
void	declareInterface (I *i)

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

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

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

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

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

SmartIF< PropertyMgr >	m_propertyMgr
	Property Manager. More...

Detailed Description

Tool to scan a transient store branch that collects all the objects that belong to the same source (file).

By default, the list of entries is cached and the cache is cleared at every BeginEvent incident.

Properties:

: DataService (string): Name of the data service to use [EventDataSvc]

: Root (string): Path to the element from which to start the scan [root of the data service]

: ScanOnBeginEvent (bool): If the scan has to be started during the BeginEvent incident (true) or on demand (false, default)

Definition at line 26 of file DataSvcFileEntriesTool.cpp.

Constructor & Destructor Documentation

DataSvcFileEntriesTool::DataSvcFileEntriesTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

Definition at line 104 of file DataSvcFileEntriesTool.cpp.

                                :
    base_class(type, name, parent) {
 
   declareProperty("DataService", m_dataSvcName = "EventDataSvc",
       "Name of the data service to use");
 
   declareProperty("Root", m_rootNode,
       "Path to the element from which to start the scan");
 
   declareProperty("ScanOnBeginEvent", m_scanOnBeginEvent = false,
       "If the scan has to be started during the BeginEvent incident (true) or on demand (false, default)");
 
   declareProperty("IgnoreOriginChange", m_ignoreOriginChange = false,
       "Disable the detection of the change in the origin of object between the BeginEvent and the scan");
 }

DataSvcFileEntriesTool::~DataSvcFileEntriesTool ( )

overridedefault

Destructor.

Member Function Documentation

StatusCode DataSvcFileEntriesTool::finalize ( )

override

Finalize the tool.

Definition at line 153 of file DataSvcFileEntriesTool.cpp.

                                            {
   // unregister from the incident service
   if (m_incidentSvc) {
     m_incidentSvc->removeListener(this, IncidentType::BeginEvent);
   }
   // Release the services
   m_incidentSvc.reset();
   m_dataMgrSvc.reset();
   m_dataSvc.reset();
 
   return AlgTool::finalize();
 }

void DataSvcFileEntriesTool::handle ( const Incident & incident )

override

Call-back function for the BeginEvent incident.

Clears the internal cache, cache the file ID of the Root node and, if the property ScanOnBeginEvent is set to true, scans the data service.

Definition at line 166 of file DataSvcFileEntriesTool.cpp.

                                                             {
   // Get the file id of the root node at every event
   IOpaqueAddress *addr = i_getRootNode()->address();
   if (addr)
     m_initialBase = addr->par()[0];
   else
     m_initialBase.clear(); // use empty file id if there is no address
 
   m_leaves.clear();
   if (m_scanOnBeginEvent) {
     verbose() << "::handle scanning on " << incident.type() << endmsg;
     i_collectLeaves();
   }
 }

void DataSvcFileEntriesTool::i_collectLeaves ( )

private

Scan the data service starting from the node specified as Root.

Definition at line 198 of file DataSvcFileEntriesTool.cpp.

                                              {
   i_collectLeaves(i_getRootNode());
 }

void DataSvcFileEntriesTool::i_collectLeaves ( IRegistry * reg )

private

Scan the data service starting from the specified node.

todo: implement the scanning as an IDataStoreAgent

Definition at line 203 of file DataSvcFileEntriesTool.cpp.

                                                            {
   // I do not put sanity checks on the pointers because I know how I'm calling the function
   IOpaqueAddress *addr = reg->address();
   if (addr) { // we consider only objects that are in a file
     if (msgLevel(MSG::VERBOSE))
       verbose() << "::i_collectLeaves added " << reg->identifier() << endmsg;
     m_leaves.push_back(reg->object()); // add this object
     // Origin of the current object
     const std::string& base = addr->par()[0];
     // Compare with the origin seen during BeginEvent
     if ( !m_ignoreOriginChange && (m_initialBase != base) )
       throw GaudiException("Origin of data has changed ('"
                            + m_initialBase + "' !=  '" + base
                            + "'), probably OutputStream was called before "
                                "InputCopyStream: check options",
                            name(), StatusCode::FAILURE);
 
     std::vector<IRegistry*> lfs; // leaves of the current object
     StatusCode sc = m_dataMgrSvc->objectLeaves(reg, lfs);
     if (sc.isSuccess()) {
       for(const auto& i : lfs) {
         // Continue if the leaf has the same database as the parent
         if ( i->address() && i->address()->par()[0] == base )  {
           DataObject* obj = nullptr;
           sc = m_dataSvc->retrieveObject(reg, i->name(), obj);
           if (sc.isSuccess())  {
             i_collectLeaves(i);
           } else {
             throw GaudiException("Cannot get " + i->identifier() + " from " + m_dataSvcName, name(), StatusCode::FAILURE);
           }
         }
       }
     }
   }
 }

IRegistry * DataSvcFileEntriesTool::i_getRootNode ( )

private

Return the pointer to the IRegistry object associated to the node specified as Root.

Definition at line 188 of file DataSvcFileEntriesTool.cpp.

                                                  {
   DataObject * obj = nullptr;
   StatusCode sc = m_dataSvc->retrieveObject(m_rootNode, obj);
   if (sc.isFailure()) {
     throw GaudiException("Cannot get " + m_rootNode + " from " + m_dataSvcName, name(), StatusCode::FAILURE);
   }
   return obj->registry();
 }

StatusCode DataSvcFileEntriesTool::initialize ( )

override

Initialize the tool.

Definition at line 122 of file DataSvcFileEntriesTool.cpp.

                                              {
   StatusCode sc = AlgTool::initialize();
   if (sc.isFailure()) return sc;
 
   // Retrieve the pointer to the needed services.
 
   m_incidentSvc = serviceLocator()->service("IncidentSvc");
   if ( ! m_incidentSvc ) {
     error() << "Cannot get IncidentSvc" << endmsg;
     return StatusCode::FAILURE;
   }
 
   m_dataMgrSvc = m_dataSvc = serviceLocator()->service(m_dataSvcName);
   if ( ! m_dataSvc || ! m_dataMgrSvc ) {
     error() << "Cannot get IDataProviderSvc+IDataManagerSvc " << m_dataSvcName << endmsg;
     return StatusCode::FAILURE;
   }
 
   // Register ourself to the incident service as listener for BeginEvent
   m_incidentSvc->addListener(this, IncidentType::BeginEvent);
 
   // If the Root node is not specified, take the name from the data service itself.
   if (m_rootNode.empty()) {
     m_rootNode = m_dataMgrSvc->rootName();
   }
 
   // Clear the cache (in case the instance is re-initilized).
   m_leaves.clear();
   return StatusCode::SUCCESS;
 }

const IDataStoreLeaves::LeavesList & DataSvcFileEntriesTool::leaves ( ) const

override

Return the list of collected objects.

If the scan was not yet done since the last BeginEvent incident, it is done when calling this function. The result of the scan is cached.

Definition at line 181 of file DataSvcFileEntriesTool.cpp.

                                                                         {
   if (m_leaves.empty()) {
     const_cast<DataSvcFileEntriesTool*>(this)->i_collectLeaves();
   }
   return m_leaves;
 }

Member Data Documentation

SmartIF<IDataManagerSvc> DataSvcFileEntriesTool::m_dataMgrSvc

private

Pointer to the IDataManagerSvc interface of the data service.

Definition at line 67 of file DataSvcFileEntriesTool.cpp.

SmartIF<IDataProviderSvc> DataSvcFileEntriesTool::m_dataSvc

private

Pointer to the IDataProviderSvc interface of the data service.

Definition at line 69 of file DataSvcFileEntriesTool.cpp.

std::string DataSvcFileEntriesTool::m_dataSvcName

private

Variable for the property DataService.

Definition at line 58 of file DataSvcFileEntriesTool.cpp.

bool DataSvcFileEntriesTool::m_ignoreOriginChange

private

Variable for the property ScanOnBeginEvent.

Definition at line 90 of file DataSvcFileEntriesTool.cpp.

SmartIF<IIncidentSvc> DataSvcFileEntriesTool::m_incidentSvc

private

Pointer to the incident service.

Definition at line 65 of file DataSvcFileEntriesTool.cpp.

std::string DataSvcFileEntriesTool::m_initialBase

private

File ID of the Root node.

It is cached every BeginEvent to be compared with the one seen during the collection of the leaves, to avoid that the collection is altered by previous calls to an OutputStream.

Definition at line 87 of file DataSvcFileEntriesTool.cpp.

LeavesList DataSvcFileEntriesTool::m_leaves

private

Internal cache for the list of objects found during the scan.

Definition at line 72 of file DataSvcFileEntriesTool.cpp.

std::string DataSvcFileEntriesTool::m_rootNode

private

Variable for the property Root.

Definition at line 60 of file DataSvcFileEntriesTool.cpp.

bool DataSvcFileEntriesTool::m_scanOnBeginEvent

private

Variable for the property ScanOnBeginEvent.

Definition at line 62 of file DataSvcFileEntriesTool.cpp.

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

GaudiCommonSvc/src/PersistencySvc/DataSvcFileEntriesTool.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation