Gaudi::RootEvtSelector Class Reference

Concrete event selector implementation to access ROOT files. More...

#include <GAUDIROOT/RootEvtSelector.h>

Inheritance diagram for Gaudi::RootEvtSelector:

Collaboration diagram for Gaudi::RootEvtSelector:

Public Member Functions
	RootEvtSelector (const std::string &name, ISvcLocator *svcloc)
	Service Constructor. More...
virtual	~RootEvtSelector ()=default
	Standard destructor. More...
virtual StatusCode	initialize ()
	IService implementation: Db event selector override. More...
virtual StatusCode	finalize ()
	IService implementation: Service finalization. More...
virtual StatusCode	createContext (Context *&refpCtxt) const
	Create a new event loop context. More...
virtual StatusCode	last (Context &refContext) const
	Access last item in the iteration. More...
virtual StatusCode	next (Context &refCtxt) const
	Get next iteration item from the event loop context. More...
virtual StatusCode	next (Context &refCtxt, int jump) const
	Get next iteration item from the event loop context, but skip jump elements. More...
virtual StatusCode	previous (Context &refCtxt) const
	Get previous iteration item from the event loop context. More...
virtual StatusCode	previous (Context &refCtxt, int jump) const
	Get previous iteration item from the event loop context, but skip jump elements. More...
virtual StatusCode	rewind (Context &refCtxt) const
	Rewind the dataset. More...
virtual StatusCode	createAddress (const Context &refCtxt, IOpaqueAddress *&) const
	Create new Opaque address corresponding to the current record. More...
virtual StatusCode	releaseContext (Context *&refCtxt) const
	Release existing event iteration context. More...
virtual StatusCode	resetCriteria (const std::string &cr, Context &c) const
	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...
	RootEvtSelector (const std::string &name, ISvcLocator *svcloc)
	Service Constructor. More...
virtual	~RootEvtSelector ()=default
	Standard destructor. More...
virtual StatusCode	initialize ()
	IService implementation: Db event selector override. More...
virtual StatusCode	finalize ()
	IService implementation: Service finalization. More...
virtual StatusCode	createContext (Context *&refpCtxt) const
	Create a new event loop context. More...
virtual StatusCode	last (Context &refContext) const
	Access last item in the iteration. More...
virtual StatusCode	next (Context &refCtxt) const
	Get next iteration item from the event loop context. More...
virtual StatusCode	next (Context &refCtxt, int jump) const
	Get next iteration item from the event loop context, but skip jump elements. More...
virtual StatusCode	previous (Context &refCtxt) const
	Get previous iteration item from the event loop context. More...
virtual StatusCode	previous (Context &refCtxt, int jump) const
	Get previous iteration item from the event loop context, but skip jump elements. More...
virtual StatusCode	rewind (Context &refCtxt) const
	Rewind the dataset. More...
virtual StatusCode	createAddress (const Context &refCtxt, IOpaqueAddress *&) const
	Create new Opaque address corresponding to the current record. More...
virtual StatusCode	releaseContext (Context *&refCtxt) const
	Release existing event iteration context. More...
virtual StatusCode	resetCriteria (const std::string &cr, Context &c) const
	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< BASE, Interfaces >
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...
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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Attributes
RootCnvSvc *	m_dbMgr
	Reference to the corresponding conversion service. More...
CLID	m_rootCLID
	Class id of root node to create opaque address. More...
std::string	m_persName
	Property; Name of the persistency service to search for conversion service. More...
std::string	m_cnvSvcName
	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...
std::string	m_dummy
	Property: dummy to fake backwards compatibility. More...

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

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Concrete event selector implementation to access ROOT files.

Author

M.Frank

Version

1.0

Date

20/12/2009

Definition at line 39 of file RootEvtSelector.h.

Constructor & Destructor Documentation

RootEvtSelector::RootEvtSelector	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Service Constructor.

Definition at line 99 of file RootEvtSelector.cpp.

: base_class(name, svcloc), m_rootCLID(CLID_NULL)
{
  m_cnvSvcName = "Gaudi::RootCnvSvc/RootCnvSvc";
  m_persName   = "EventPersistencySvc";
  declareProperty("EvtPersistencySvc",m_persName="EventPersistencySvc");
  declareProperty("DbType",m_dummy);
}

virtual Gaudi::RootEvtSelector::~RootEvtSelector ( )

virtualdefault

Standard destructor.

Gaudi::RootEvtSelector::RootEvtSelector	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Service Constructor.

virtual Gaudi::RootEvtSelector::~RootEvtSelector ( )

virtualdefault

Standard destructor.

Member Function Documentation

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

virtual

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 271 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;
}

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

virtual

Create new Opaque address corresponding to the current record.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

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

virtual

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 164 of file RootEvtSelector.cpp.

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

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

virtual

Create a new event loop context.

Parameters

refpCtxt

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

Returns

StatusCode indicating success or failure

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

private

Helper method to issue error messages.

Definition at line 109 of file RootEvtSelector.cpp.

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

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

private

Helper method to issue error messages.

virtual StatusCode Gaudi::RootEvtSelector::finalize ( )

virtual

IService implementation: Service finalization.

StatusCode RootEvtSelector::finalize ( )

virtual

IService implementation: Service finalization.

Definition at line 156 of file RootEvtSelector.cpp.

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

StatusCode RootEvtSelector::initialize ( )

virtual

IService implementation: Db event selector override.

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

virtual StatusCode Gaudi::RootEvtSelector::initialize ( )

virtual

IService implementation: Db event selector override.

virtual StatusCode Gaudi::RootEvtSelector::last ( Context &  refContext ) const

virtual

Access last item in the iteration.

Parameters

refContext

[IN/OUT] Reference to the Context object.

StatusCode RootEvtSelector::last ( Context &  refContext ) const

virtual

Access last item in the iteration.

Parameters

refContext

[IN/OUT] Reference to the Context object.

Definition at line 170 of file RootEvtSelector.cpp.

                                                  {
  return StatusCode::FAILURE;
}

virtual StatusCode Gaudi::RootEvtSelector::next ( Context &  refCtxt ) const

virtual

Get next iteration item from the event loop context.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

StatusCode RootEvtSelector::next ( Context &  refCtxt ) const

virtual

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 175 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;
}

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

virtual

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

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

virtual

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 219 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;
}

StatusCode RootEvtSelector::previous ( Context &  refCtxt ) const

virtual

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 233 of file RootEvtSelector.cpp.

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

virtual StatusCode Gaudi::RootEvtSelector::previous ( Context &  refCtxt ) const

virtual

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

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

virtual

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

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

virtual

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 238 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;
}

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

virtual

Release existing event iteration context.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

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

virtual

Release existing event iteration context.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

Definition at line 289 of file RootEvtSelector.cpp.

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

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

virtual

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 301 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 )); // 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.");
}

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

virtual

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.

virtual StatusCode Gaudi::RootEvtSelector::rewind ( Context &  refCtxt ) const

virtual

Rewind the dataset.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

StatusCode RootEvtSelector::rewind ( Context &  refCtxt ) const

virtual

Rewind the dataset.

Parameters

refCtxt

[IN/OUT] Reference to the context

Returns

StatusCode indicating success or failure

Definition at line 252 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

std::string Gaudi::RootEvtSelector::m_cnvSvcName

protected

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

Definition at line 136 of file RootEvtSelector.h.

std::string Gaudi::RootEvtSelector::m_criteria

protected

Property: File criteria to define item iteration.

Definition at line 140 of file RootEvtSelector.h.

RootCnvSvc * Gaudi::RootEvtSelector::m_dbMgr

mutableprotected

Reference to the corresponding conversion service.

Definition at line 130 of file RootEvtSelector.h.

std::string Gaudi::RootEvtSelector::m_dummy

protected

Property: dummy to fake backwards compatibility.

Definition at line 142 of file RootEvtSelector.h.

std::string Gaudi::RootEvtSelector::m_persName

protected

Property; Name of the persistency service to search for conversion service.

Definition at line 134 of file RootEvtSelector.h.

CLID Gaudi::RootEvtSelector::m_rootCLID

protected

Class id of root node to create opaque address.

Definition at line 132 of file RootEvtSelector.h.

std::string Gaudi::RootEvtSelector::m_rootName

protected

Property: Name of the ROOT entry name.

Definition at line 138 of file RootEvtSelector.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/RootCnv/RootEvtSelector.h
• RootCnv/src/RootEvtSelector.cpp