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

Inheritance diagram for DataSvcFileEntriesTool:

[legend]

Collaboration diagram for DataSvcFileEntriesTool:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialize the tool.

StatusCode	finalize () override
	Finalize the tool.

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

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

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

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

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

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

void const *	i_cast (const InterfaceID &riid) const override

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

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

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

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.

StatusCode	sysStart () override
	Start AlgTool.

StatusCode	sysStop () override
	Stop AlgTool.

StatusCode	sysFinalize () override
	Finalize AlgTool.

StatusCode	sysReinitialize () override
	Initialize AlgTool.

StatusCode	sysRestart () override
	Start AlgTool.

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

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

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

IDataProviderSvc *	evtSvc () const
	accessor to event service service

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

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

template<typename T>
SmartIF< T >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const

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

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

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

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

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

IAuditorSvc *	auditorSvc () const
	Access the auditor service.

IMonitorSvc *	monitorSvc () const
	Access the monitor service.

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

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)

	~AlgTool () override

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

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

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

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

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

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

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
Gaudi::Property< std::string >	m_dataSvcName { this, "DataService", "EventDataSvc", "Name of the data service to use" }

Gaudi::Property< std::string >	m_rootNode { this, "Root", "", "Path to the element from which to start the scan" }

Gaudi::Property< bool >	m_scanOnBeginEvent

Gaudi::Property< bool >	m_ignoreOriginChange

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service.

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

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

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

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

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

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from AlgTool
using	Factory = Gaudi::PluginService::Factory<IAlgTool( const std::string&, const std::string&, const IInterface )>

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

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

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

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

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

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this

Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

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

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

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 37 of file DataSvcFileEntriesTool.cpp.

Member Function Documentation

◆ finalize()

StatusCode DataSvcFileEntriesTool::finalize ( )

override

Finalize the tool.

Definition at line 135 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();
}

◆ handle()

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

◆ i_collectLeaves() [1/2]

void DataSvcFileEntriesTool::i_collectLeaves ( )

private

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

Definition at line 175 of file DataSvcFileEntriesTool.cpp.

175{ i_collectLeaves( i_getRootNode() ); }

◆ i_collectLeaves() [2/2]

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

◆ i_getRootNode()

IRegistry * DataSvcFileEntriesTool::i_getRootNode ( )

private

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

Definition at line 166 of file DataSvcFileEntriesTool.cpp.

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

◆ initialize()

StatusCode DataSvcFileEntriesTool::initialize ( )

override

Initialize the tool.

Definition at line 106 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;
}

◆ leaves()

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 161 of file DataSvcFileEntriesTool.cpp.

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

Member Data Documentation

◆ m_dataMgrSvc

SmartIF<IDataManagerSvc> DataSvcFileEntriesTool::m_dataMgrSvc

private

Pointer to the IDataManagerSvc interface of the data service.

Definition at line 72 of file DataSvcFileEntriesTool.cpp.

◆ m_dataSvc

SmartIF<IDataProviderSvc> DataSvcFileEntriesTool::m_dataSvc

private

Pointer to the IDataProviderSvc interface of the data service.

Definition at line 74 of file DataSvcFileEntriesTool.cpp.

◆ m_dataSvcName

Gaudi::Property<std::string> DataSvcFileEntriesTool::m_dataSvcName { this, "DataService", "EventDataSvc", "Name of the data service to use" }

private

Definition at line 60 of file DataSvcFileEntriesTool.cpp.

60{ this, "DataService", "EventDataSvc", "Name of the data service to use" };

◆ m_ignoreOriginChange

Gaudi::Property<bool> DataSvcFileEntriesTool::m_ignoreOriginChange

private

Initial value:

{
      this, "IgnoreOriginChange", false,
      "Disable the detection of the change in the origin of object between the BeginEvent and the scan" }

Definition at line 65 of file DataSvcFileEntriesTool.cpp.

                                          {
      this, "IgnoreOriginChange", false,
      "Disable the detection of the change in the origin of object between the BeginEvent and the scan" };

◆ m_incidentSvc

SmartIF<IIncidentSvc> DataSvcFileEntriesTool::m_incidentSvc

private

Pointer to the incident service.

Definition at line 70 of file DataSvcFileEntriesTool.cpp.

◆ m_initialBase

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 92 of file DataSvcFileEntriesTool.cpp.

◆ m_leaves

LeavesList DataSvcFileEntriesTool::m_leaves

private

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

Definition at line 77 of file DataSvcFileEntriesTool.cpp.

◆ m_rootNode

Gaudi::Property<std::string> DataSvcFileEntriesTool::m_rootNode { this, "Root", "", "Path to the element from which to start the scan" }

private

Definition at line 61 of file DataSvcFileEntriesTool.cpp.

61{ this, "Root", "", "Path to the element from which to start the scan" };

◆ m_scanOnBeginEvent

Gaudi::Property<bool> DataSvcFileEntriesTool::m_scanOnBeginEvent

private

Initial value:

{
      this, "ScanOnBeginEvent", false,
      "If the scan has to be started during the BeginEvent incident (true) or on demand (false, default)" }

Definition at line 62 of file DataSvcFileEntriesTool.cpp.

                                               {
      this, "ScanOnBeginEvent", false,
      "If the scan has to be started during the BeginEvent incident (true) or on demand (false, default)" };

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

Member Function Documentation

◆ finalize()

◆ handle()

◆ i_collectLeaves() [1/2]

◆ i_collectLeaves() [2/2]

◆ i_getRootNode()

◆ initialize()

◆ leaves()

Member Data Documentation

◆ m_dataMgrSvc

◆ m_dataSvc

◆ m_dataSvcName

◆ m_ignoreOriginChange

◆ m_incidentSvc

◆ m_initialBase

◆ m_leaves

◆ m_rootNode

◆ m_scanOnBeginEvent