#include <GAUDIROOT/RootEvtSelector.h>

Inheritance diagram for Gaudi::RootEvtSelector:

[legend]

Collaboration diagram for Gaudi::RootEvtSelector:

[legend]

Public Member Functions
StatusCode	initialize () override
	IService implementation: Db event selector override. More...

StatusCode	finalize () override
	IService implementation: Service finalization. More...

StatusCode	createContext (Context *&refpCtxt) const override
	Create a new event loop context. More...

StatusCode	last (Context &refContext) const override
	Access last item in the iteration. More...

StatusCode	next (Context &refCtxt) const override
	Get next iteration item from the event loop context. More...

StatusCode	next (Context &refCtxt, int jump) const override
	Get next iteration item from the event loop context, but skip jump elements. More...

StatusCode	previous (Context &refCtxt) const override
	Get previous iteration item from the event loop context. More...

StatusCode	previous (Context &refCtxt, int jump) const override
	Get previous iteration item from the event loop context, but skip jump elements. More...

StatusCode	rewind (Context &refCtxt) const override
	Rewind the dataset. More...

StatusCode	createAddress (const Context &refCtxt, IOpaqueAddress *&) const override
	Create new Opaque address corresponding to the current record. More...

StatusCode	releaseContext (Context *&refCtxt) const override
	Release existing event iteration context. More...

StatusCode	resetCriteria (const std::string &cr, Context &c) const override
	Will set a new criteria for the selection of the next list of events and will change the state of the context in a way to point to the new list. More...

Public Member Functions inherited from extends< Service, IEvtSelector >
void const *	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...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

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

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

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor More...

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

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) 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)
	Declare used tool. More...

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)

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

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

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

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

	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. More...

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

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

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

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

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

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

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

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

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

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

Protected Attributes
RootCnvSvc *	m_dbMgr
	Reference to the corresponding conversion service. More...

CLID	m_rootCLID = CLID_NULL
	Class id of root node to create opaque address. More...

Gaudi::Property< std::string >	m_persName

Gaudi::Property< std::string >	m_dummy { this, "DbType", "", "dummy property to fake backwards compatibility" }

std::string	m_cnvSvcName = "Gaudi::RootCnvSvc/RootCnvSvc"
	Property; Name of the concversion service used to create opaque addresses. More...

std::string	m_rootName
	Property: Name of the ROOT entry name. More...

std::string	m_criteria
	Property: File criteria to define item iteration. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Private Member Functions
StatusCode	error (const std::string &msg) const
	Helper method to issue error messages. More...

Additional Inherited Members
Public Types inherited from extends< Service, IEvtSelector >
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 Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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

Public Types inherited from CommonMessaging< implements< IService, 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 Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level More...

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

Detailed Description

Concrete event selector implementation to access ROOT files.

Author: M.Frank

Version: 1.0

Date: 20/12/2009

Definition at line 48 of file RootEvtSelector.h.

Member Function Documentation

◆ createAddress()

StatusCode RootEvtSelector::createAddress	(	const Context &	refCtxt,
		IOpaqueAddress *&	pAddr
	)		const

override

Create new Opaque address corresponding to the current record.

Parameters

refCtxt [IN/OUT] Reference to the context

Returns: StatusCode indicating success or failure

Definition at line 262 of file RootEvtSelector.cpp.

                                                                                              {
   const RootEvtSelectorContext* pctxt = dynamic_cast<const RootEvtSelectorContext*>( &ctxt );
   if ( pctxt ) {
     long ent = pctxt->entry();
     if ( ent >= 0 ) {
       auto fileit = pctxt->fileIterator();
       if ( fileit != pctxt->files().end() ) {
         const string        par[2]  = { pctxt->fid(), m_rootName };
         const unsigned long ipar[2] = { 0, (unsigned long)ent };
         return m_dbMgr->createAddress( m_dbMgr->repSvcType(), m_rootCLID, &par[0], &ipar[0], pAddr );
       }
     }
   }
   pAddr = nullptr;
   return StatusCode::FAILURE;
 }

◆ createContext()

StatusCode RootEvtSelector::createContext ( Context *& refpCtxt ) const

override

Create a new event loop context.

Parameters

refpCtxt [IN/OUT] Reference to pointer to store the context

Returns: StatusCode indicating success or failure

Definition at line 162 of file RootEvtSelector.cpp.

                                                                     {
   refpCtxt = new RootEvtSelectorContext( this );
   return StatusCode::SUCCESS;
 }

◆ error()

StatusCode RootEvtSelector::error ( const std::string & msg ) const

private

Helper method to issue error messages.

Definition at line 113 of file RootEvtSelector.cpp.

                                                            {
   MsgStream log( msgSvc(), name() );
   log << MSG::ERROR << msg << endmsg;
   return StatusCode::FAILURE;
 }

◆ finalize()

StatusCode RootEvtSelector::finalize ( )

override

IService implementation: Service finalization.

Definition at line 154 of file RootEvtSelector.cpp.

                                      {
   // Initialize base class
   if ( m_dbMgr ) m_dbMgr->release();
   m_dbMgr = nullptr; // release
   return Service::finalize();
 }

◆ initialize()

StatusCode RootEvtSelector::initialize ( )

override

IService implementation: Db event selector override.

Definition at line 120 of file RootEvtSelector.cpp.

                                        {
   // Initialize base class
   StatusCode status = Service::initialize();
   if ( !status.isSuccess() ) { return error( "Error initializing base class Service!" ); }
  
   auto ipers = serviceLocator()->service<IPersistencySvc>( m_persName );
   if ( !ipers ) { return error( "Unable to locate IPersistencySvc interface of " + m_persName ); }
   IConversionSvc*              cnvSvc = nullptr;
   Gaudi::Utils::TypeNameString itm( m_cnvSvcName );
   status = ipers->getService( itm.name(), cnvSvc );
   if ( !status.isSuccess() ) {
     status = ipers->getService( itm.type(), cnvSvc );
     if ( !status.isSuccess() ) {
       return error( "Unable to locate IConversionSvc interface of database type " + m_cnvSvcName );
     }
   }
   m_dbMgr = dynamic_cast<RootCnvSvc*>( cnvSvc );
   if ( !m_dbMgr ) {
     cnvSvc->release();
     return error( "Unable to localize service:" + m_cnvSvcName );
   }
   m_dbMgr->addRef();
  
   // Get DataSvc
   auto eds = serviceLocator()->service<IDataManagerSvc>( "EventDataSvc" );
   if ( !eds ) { return error( "Unable to localize service EventDataSvc" ); }
   m_rootCLID = eds->rootCLID();
   m_rootName = eds->rootName();
   MsgStream log( msgSvc(), name() );
   log << MSG::DEBUG << "Selection root:" << m_rootName << " CLID:" << m_rootCLID << endmsg;
   return status;
 }

◆ last()

StatusCode RootEvtSelector::last ( Context & refContext ) const

override

Access last item in the iteration.

Parameters

refContext [IN/OUT] Reference to the Context object.

Definition at line 168 of file RootEvtSelector.cpp.

168 { return StatusCode::FAILURE; }

◆ next() [1/2]

StatusCode RootEvtSelector::next ( Context & refCtxt ) const

override

Get next iteration item from the event loop context.

Parameters

refCtxt [IN/OUT] Reference to the context

Returns: StatusCode indicating success or failure

Definition at line 171 of file RootEvtSelector.cpp.

                                                       {
   RootEvtSelectorContext* pCtxt = dynamic_cast<RootEvtSelectorContext*>( &ctxt );
   if ( pCtxt ) {
     TBranch* b = pCtxt->branch();
     if ( !b ) {
       auto fileit = pCtxt->fileIterator();
       pCtxt->setBranch( nullptr );
       pCtxt->setEntry( -1 );
       if ( fileit != pCtxt->files().end() ) {
         RootDataConnection* con = nullptr;
         string              in  = *fileit;
         StatusCode          sc  = m_dbMgr->connectDatabase( in, IDataConnection::READ, &con );
         if ( sc.isSuccess() ) {
           string section = m_rootName[0] == '/' ? m_rootName.substr( 1 ) : m_rootName;
           b              = con->getBranch( section, m_rootName );
           if ( b ) {
             pCtxt->setFID( con->fid() );
             pCtxt->setBranch( b );
             return next( ctxt );
           }
         }
         m_dbMgr->disconnect( in ).ignore();
         pCtxt->setFileIterator( ++fileit );
         return next( ctxt );
       }
       return StatusCode::FAILURE;
     }
     long     ent  = pCtxt->entry();
     Long64_t nent = b->GetEntries();
     if ( nent > ( ent + 1 ) ) {
       pCtxt->setEntry( ++ent );
       return StatusCode::SUCCESS;
     }
     auto fit = pCtxt->fileIterator();
     pCtxt->setFileIterator( ++fit );
     pCtxt->setEntry( -1 );
     pCtxt->setBranch( nullptr );
     pCtxt->setFID( "" );
     return next( ctxt );
   }
   return StatusCode::FAILURE;
 }

◆ next() [2/2]

StatusCode RootEvtSelector::next	(	Context &	refCtxt,
		int	jump
	)		const

override

Get next iteration item from the event loop context, but skip jump elements.

Parameters

refCtxt [IN/OUT] Reference to the context

Returns: StatusCode indicating success or failure

Definition at line 215 of file RootEvtSelector.cpp.

                                                                 {
   if ( jump > 0 ) {
     for ( int i = 0; i < jump; ++i ) {
       StatusCode status = next( ctxt );
       if ( !status.isSuccess() ) { return status; }
     }
     return StatusCode::SUCCESS;
   }
   return StatusCode::FAILURE;
 }

◆ previous() [1/2]

StatusCode RootEvtSelector::previous ( Context & refCtxt ) const

override

Get previous iteration item from the event loop context.

Parameters

refCtxt	[IN/OUT] Reference to the context
jump	[IN] Number of events to be skipped

Returns: StatusCode indicating success or failure

Definition at line 227 of file RootEvtSelector.cpp.

                                                        {
   return error( "EventSelector Iterator, operator -- not supported " );
 }

◆ previous() [2/2]

StatusCode RootEvtSelector::previous	(	Context &	refCtxt,
		int	jump
	)		const

override

Get previous iteration item from the event loop context, but skip jump elements.

Parameters

refCtxt	[IN/OUT] Reference to the context
jump	[IN] Number of events to be skipped

Returns: StatusCode indicating success or failure

Definition at line 232 of file RootEvtSelector.cpp.

                                                                     {
   if ( jump > 0 ) {
     for ( int i = 0; i < jump; ++i ) {
       StatusCode status = previous( ctxt );
       if ( !status.isSuccess() ) { return status; }
     }
     return StatusCode::SUCCESS;
   }
   return StatusCode::FAILURE;
 }

◆ releaseContext()

StatusCode RootEvtSelector::releaseContext ( Context *& refCtxt ) const

override

Release existing event iteration context.

Parameters

refCtxt [IN/OUT] Reference to the context

Returns: StatusCode indicating success or failure

Definition at line 280 of file RootEvtSelector.cpp.

                                                                  {
   RootEvtSelectorContext* pCtxt = dynamic_cast<RootEvtSelectorContext*>( ctxt );
   if ( pCtxt ) {
     delete pCtxt;
     return StatusCode::SUCCESS;
   }
   return StatusCode::FAILURE;
 }

◆ resetCriteria()

StatusCode RootEvtSelector::resetCriteria	(	const std::string &	cr,
		Context &	c
	)		const

override

Will set a new criteria for the selection of the next list of events and will change the state of the context in a way to point to the new list.

Parameters

cr	The new criteria string.
c	Reference pointer to the Context object.

Definition at line 291 of file RootEvtSelector.cpp.

                                                                                           {
   MsgStream               log( msgSvc(), name() );
   RootEvtSelectorContext* ctxt = dynamic_cast<RootEvtSelectorContext*>( &context );
   string                  db, typ, item, sel, stmt, aut, addr;
   if ( ctxt ) {
     if ( criteria.compare( 0, 5, "FILE " ) == 0 ) {
       // The format for the criteria is:
       //        FILE  filename1, filename2 ...
       db = criteria.substr( 5 );
     } else {
       using Parser = Gaudi::Utils::AttribStringParser;
       for ( auto attrib : Parser( criteria ) ) {
         string tmp = attrib.tag.substr( 0, 3 );
         if ( tmp == "DAT" ) {
           db = std::move( attrib.value );
         } else if ( tmp == "OPT" ) {
           if ( attrib.value.compare( 0, 3, "REA" ) != 0 ) {
             log << MSG::ERROR << "Option:\"" << attrib.value << "\" not valid" << endmsg;
             return StatusCode::FAILURE;
           }
         } else if ( tmp == "TYP" ) {
           typ = std::move( attrib.value );
         } else if ( tmp == "ADD" ) {
           item = std::move( attrib.value );
         } else if ( tmp == "SEL" ) {
           sel = std::move( attrib.value );
         } else if ( tmp == "FUN" ) {
           stmt = std::move( attrib.value );
         } else if ( tmp == "AUT" ) {
           aut = std::move( attrib.value );
         } else if ( tmp == "COL" ) {
           addr = std::move( attrib.value );
         }
       }
     }
     // It's now time to parse the criteria for the event selection
     // The format for the criteria is:
     //        FILE  filename1, filename2 ...
     //        JOBID number1-number2, number3, ...
     RootEvtSelectorContext::Files files;
     string                        rest = db;
     files.clear();
     while ( true ) {
       int ipos = rest.find_first_not_of( " ," );
       if ( ipos == -1 ) break;
       rest     = rest.substr( ipos, string::npos ); // remove blanks before
       int lpos = rest.find_first_of( " ," );        // locate next blank
  
       files.push_back( rest.substr( 0, lpos == -1 ? string::npos : lpos ) ); // insert in list
       if ( lpos == -1 ) break;
       rest = rest.substr( lpos, string::npos ); // get the rest
     }
     ctxt->setFiles( files );
     ctxt->setFileIterator( ctxt->files().begin() );
     return StatusCode::SUCCESS;
   }
   return error( "Invalid iteration context." );
 }

◆ rewind()

StatusCode RootEvtSelector::rewind ( Context & refCtxt ) const

override

Rewind the dataset.

Parameters

refCtxt [IN/OUT] Reference to the context

Returns: StatusCode indicating success or failure

Definition at line 244 of file RootEvtSelector.cpp.

                                                         {
   RootEvtSelectorContext* pCtxt = dynamic_cast<RootEvtSelectorContext*>( &ctxt );
   if ( pCtxt ) {
     auto fileit = pCtxt->fileIterator();
     if ( fileit != pCtxt->files().end() ) {
       string input = *fileit;
       m_dbMgr->disconnect( input ).ignore();
     }
     pCtxt->setFID( "" );
     pCtxt->setEntry( -1 );
     pCtxt->setBranch( nullptr );
     pCtxt->setFileIterator( pCtxt->files().begin() );
     return StatusCode::SUCCESS;
   }
   return StatusCode::FAILURE;
 }

Member Data Documentation

◆ m_cnvSvcName

std::string Gaudi::RootEvtSelector::m_cnvSvcName = "Gaudi::RootCnvSvc/RootCnvSvc"

protected

Property; Name of the concversion service used to create opaque addresses.

Definition at line 146 of file RootEvtSelector.h.

◆ m_criteria

std::string Gaudi::RootEvtSelector::m_criteria

protected

Property: File criteria to define item iteration.

Definition at line 150 of file RootEvtSelector.h.

◆ m_dbMgr

RootCnvSvc* Gaudi::RootEvtSelector::m_dbMgr

mutableprotected

Reference to the corresponding conversion service.

Definition at line 137 of file RootEvtSelector.h.

◆ m_dummy

Gaudi::Property<std::string> Gaudi::RootEvtSelector::m_dummy { this, "DbType", "", "dummy property to fake backwards compatibility" }

protected

Definition at line 143 of file RootEvtSelector.h.

◆ m_persName

Gaudi::Property<std::string> Gaudi::RootEvtSelector::m_persName

protected

Initial value:

{ this, "EvtPersistencySvc", "EventPersistencySvc",

"Name of the persistency service to search for conversion service" }

Definition at line 141 of file RootEvtSelector.h.

◆ m_rootCLID

CLID Gaudi::RootEvtSelector::m_rootCLID = CLID_NULL

protected

Class id of root node to create opaque address.

Definition at line 139 of file RootEvtSelector.h.

◆ m_rootName

std::string Gaudi::RootEvtSelector::m_rootName

protected

Property: Name of the ROOT entry name.

Definition at line 148 of file RootEvtSelector.h.

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

RootCnv/include/RootCnv/RootEvtSelector.h
RootCnv/src/RootEvtSelector.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createAddress()

◆ createContext()

◆ error()

◆ finalize()

◆ initialize()

◆ last()

◆ next() [1/2]

◆ next() [2/2]

◆ previous() [1/2]

◆ previous() [2/2]

◆ releaseContext()

◆ resetCriteria()

◆ rewind()

Member Data Documentation

◆ m_cnvSvcName

◆ m_criteria

◆ m_dbMgr

◆ m_dummy

◆ m_persName

◆ m_rootCLID

◆ m_rootName