EventCollectionSelector Class Reference

Definition of class EventCollectionSelector. More...

#include <src/EventSelector/EventCollectionSelector.h>

Inheritance diagram for EventCollectionSelector:

Collaboration diagram for EventCollectionSelector:

Classes
class	MyContextType

Public Member Functions
StatusCode	initialize () override
	Service override: Initialize service. More...
StatusCode	finalize () override
	Service override: Finalize Service. More...
StatusCode	createContext (Context *&refpCtxt) const override
	Create a new event loop context. 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 *&refpAddr) 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...
StatusCode	last (Context &refCtxt) const override
	Access last item in the iteration. More...
virtual StatusCode	connectCollection (MyContextType *ctxt) const
	Connect collection to selector. More...
virtual StatusCode	connectDataSource (const std::string &db, const std::string &typ) const
	Connect collection's data source to selector. More...
virtual StatusCode	connectTuple (const std::string &nam, const std::string &itName, NTuple::Tuple *&tup, NTuple::Item< IOpaqueAddress * > *&item) const
	Connect to existing N-tuple. More...
virtual StatusCode	connectStatement (const std::string &typ, const std::string &crit, INTuple *tuple) const
	Connect selection statement to refine data access. More...
virtual StatusCode	getNextRecord (NTuple::Tuple *tuple) const
	Read next record of the N-tuple. More...
virtual StatusCode	getPreviousRecord (NTuple::Tuple *tuple) const
	Read next record of the N-tuple. More...
	EventCollectionSelector (const std::string &name, ISvcLocator *svcloc)
	Standard Constructor. More...
	~EventCollectionSelector () override=default
	Standard Destructor. 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
SmartIF< INTupleSvc >	m_tupleSvc
	Reference to Tuple service. More...
SmartIF< IAddressCreator >	m_pAddrCreator
std::string	m_tupleSvcName
	Name of the event collection service name. More...
std::string	m_authentication
	Authentication string (if needed) More...
std::string	m_cntName
	Container name. More...
std::string	m_itemName
	Item name. More...
std::string	m_criteria
	Criteria. More...
std::string	m_database
	Datafile name. More...
std::string	m_dbType
	Database type identifier. More...
std::string	m_dbSvc
	Database service (exclusive property with db type) More...
std::string	m_statement
	Selector name. 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

Definition of class EventCollectionSelector.

Basic event selector service. The event selector service itself is able to connect other services to attached streams.

History: +------—+-------------------------------------------—+------—+ | Date | Comment | Who | +------—+-------------------------------------------—+------—+ | 3/10/00 | Initial version | M.Frank | +------—+-------------------------------------------—+------—+

Author

Markus Frank

Version

1.0

Definition at line 41 of file EventCollectionSelector.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 76 of file EventCollectionSelector.cpp.

  : base_class(name, svcloc)
{
  declareProperty("CnvService",    m_tupleSvcName = "EvtTupleSvc");
  declareProperty("Authentication",m_authentication= "");
  declareProperty("Container",     m_cntName  = "B2PiPi");
  declareProperty("Item",          m_itemName = "Address");
  declareProperty("Criteria",      m_criteria = "");
  declareProperty("DB",            m_database = "");
  declareProperty("DbType",        m_dbType   = "");
  declareProperty("DbService",     m_dbSvc    = "");
  declareProperty("Function",      m_statement= "NTuple::Selector");
}

EventCollectionSelector::~EventCollectionSelector ( )

overridedefault

Standard Destructor.

Member Function Documentation

StatusCode EventCollectionSelector::connectCollection ( MyContextType *  ctxt ) const

virtual

Connect collection to selector.

Definition at line 222 of file EventCollectionSelector.cpp.

{
  if ( ctxt )  {
    StatusCode status = connectDataSource(m_database, m_dbType);
    if ( status.isSuccess() )   {
      status = connectTuple(m_cntName, m_itemName, ctxt->tuple, ctxt->item);
      if ( status.isSuccess() )   {
        status = connectStatement(m_statement, m_criteria, ctxt->tuple);
        if ( status.isSuccess() )   {
          *(ctxt->item) = 0;
          return status;
        }
      }
    }
    return status;
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::connectDataSource ( const std::string &  db, const std::string &  typ  ) const

virtual

Connect collection's data source to selector.

Definition at line 114 of file EventCollectionSelector.cpp.

                                                                                          {
  StatusCode status = StatusCode::FAILURE;
  SmartIF<IDataSourceMgr> svc(m_tupleSvc);
  if ( svc && !db.empty()  )   {
    std::string ident = name() + ' ';
    ident += "DATAFILE='" + m_database.substr(5) + "' ";
    if ( !m_dbSvc.empty() )
      ident += "SVC='" + m_dbSvc + "' ";
    else
      ident += "TYP='" + m_dbType + "' ";
    ident += "OPT='READ' ";
    if ( m_authentication.length() > 0 )    {
      ident += "AUTH='" + m_authentication + "' ";
    }
    status = svc->connect(ident);
  }
  return status;
}

StatusCode EventCollectionSelector::connectStatement ( const std::string &  typ, const std::string &  crit, INTuple *  tuple  ) const

virtual

Connect selection statement to refine data access.

Definition at line 157 of file EventCollectionSelector.cpp.

                                                                                                            {
  std::string seltyp = typ;
  if ( !seltyp.empty() || !crit.empty() )   {
    if ( !crit.empty() && seltyp.length() == 0 ) seltyp = "NTuple::Selector";
    SmartIF<ISelectStatement> stmt(ObjFactory::create(seltyp, serviceLocator()));
    if ( stmt )    {
      if ( !crit.empty() ) stmt->setCriteria(crit);
      tuple->attachSelector(stmt).ignore();
      return StatusCode::SUCCESS;
    }
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

StatusCode EventCollectionSelector::connectTuple ( const std::string &  nam, const std::string &  itName, NTuple::Tuple *&  tup, NTuple::Item< IOpaqueAddress * > *&  item  ) const

virtual

Connect to existing N-tuple.

Definition at line 135 of file EventCollectionSelector.cpp.

                                                                                                                                                 {
  std::string top = "/NTUPLES/" + name() + '/' + nam;
  StatusCode status = m_tupleSvc->retrieveObject(top, (DataObject*&)tup);
  if ( status.isSuccess() )    {
    item = new NTuple::Item<IOpaqueAddress*>();
    status = tup->item(itName, *item);
    if ( status.isSuccess() ) return status;
    MsgStream log(msgSvc(), name());
    log << MSG::ERROR << "Item " << itName << " is not part of the collection:" << top << endmsg;
    delete item;
    item = nullptr;
  }
  else  {
    MsgStream err(msgSvc(), name());
    err << MSG::ERROR << "Cannot connect to collection:" << top << endmsg;
  }
  tup = nullptr;
  return status;
}

StatusCode EventCollectionSelector::createAddress ( const Context &  refCtxt, IOpaqueAddress *&  refpAddr  ) const

override

Create new Opaque address corresponding to the current record.

Parameters

refCtxt	[IN/OUT] Reference to the context
refpAddr	[OUT] Reference to address pointer

Returns

StatusCode indicating success or failure

Definition at line 320 of file EventCollectionSelector.cpp.

{
  const MyContextType* ctxt = dynamic_cast<const MyContextType*>(&refCtxt);
  if ( ctxt )   {
    IOpaqueAddress* pA = *(ctxt->item);
    if ( pA )  {
      IOpaqueAddress* pAddress = nullptr;
      StatusCode status = m_pAddrCreator->createAddress(pA->svcType(),
                                                        pA->clID(),
                                                        pA->par(),
                                                        pA->ipar(),
                                                        pAddress);
      if ( status.isSuccess() )   {
        refpAddr = pAddress;
        return StatusCode::SUCCESS;
      }
      else    {
        MsgStream log(msgSvc(), name());
        log << MSG::ERROR << "Failed to access " << pA->par()[0]
            << ":" << pA->par()[1]
            << " SvcTyp:" << long(pA->svcType())
            << " CLID:"   << pA->clID()
            << endmsg;
      }
    }
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::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 251 of file EventCollectionSelector.cpp.

{
  refpCtxt = nullptr;
  std::unique_ptr<MyContextType> ctxt(new MyContextType());
  StatusCode status = connectCollection(ctxt.get());
  if( !status.isSuccess() )  {
    MsgStream log(msgSvc(), name());
    log << MSG::ERROR << "Unable to connect Collection file \"" << m_database << "\"" << endmsg;
    return status;
  }
  refpCtxt = ctxt.release();
  return StatusCode::SUCCESS;
}

StatusCode EventCollectionSelector::finalize ( )

override

Service override: Finalize Service.

Definition at line 242 of file EventCollectionSelector.cpp.

                                                {
  // release services
  m_pAddrCreator = nullptr;
  m_tupleSvc = nullptr;
  return Service::finalize();
}

StatusCode EventCollectionSelector::getNextRecord ( NTuple::Tuple *  tuple ) const

virtual

Read next record of the N-tuple.

Definition at line 173 of file EventCollectionSelector.cpp.

                                                                            {
  StatusCode status = StatusCode::FAILURE;
  if ( tuple )   {
    do {
      status = m_tupleSvc->readRecord(tuple);
      if ( status.isSuccess() )   {
        ISelectStatement* statement = tuple->selector();
        bool use_it = (statement) ? (*statement)(tuple) : true;
        if ( use_it )   {
          return status;
        }
      }
    } while ( status.isSuccess() );
  }
  return status;
}

StatusCode EventCollectionSelector::getPreviousRecord ( NTuple::Tuple *  tuple ) const

virtual

Read next record of the N-tuple.

Read previous record of the N-tuple.

Definition at line 191 of file EventCollectionSelector.cpp.

                                                                                 {
  StatusCode status = StatusCode::FAILURE;
  if ( tuple )  {
    IRegistry* pReg = tuple->registry();
    if ( pReg )  {
      IOpaqueAddress* pAddr = pReg->address();
      if ( pAddr )  {
        long* ip = (long*)pAddr->ipar();
        do {
          if ( ip[1] > 1 )  {
            ip[1] -= 2;
            status = m_tupleSvc->readRecord(tuple);
            if ( status.isSuccess() )   {
              ISelectStatement* statement = tuple->selector();
              bool use_it = (statement) ? (*statement)(tuple) : true;
              if ( use_it )   {
                return status;
              }
            }
          }
          else  {
            return StatusCode::FAILURE;
          }
        } while ( status.isSuccess() );
      }
    }
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::initialize ( )

override

Service override: Initialize service.

Definition at line 91 of file EventCollectionSelector.cpp.

                                                  {
  // Initialize base class
  StatusCode status = Service::initialize();
  MsgStream log(msgSvc(), name());
  if ( !status.isSuccess() )    {
    log << MSG::ERROR << "Error initializing base class Service!" << endmsg;
    return status;
  }
  m_pAddrCreator = serviceLocator()->service("EventPersistencySvc");
  if(!m_pAddrCreator) {
    log << MSG::ERROR << "Unable to locate IAddressCreator interface of " << "EventPersistencySvc" << endmsg;
    return status;
  }
  m_tupleSvc = serviceLocator()->service(m_tupleSvcName);
  if( !m_tupleSvc )   {
    log << MSG::ERROR << "Unable to locate INTupleSvc interface of " << m_tupleSvcName << endmsg;
    return status;
  }
  return status;
}

StatusCode EventCollectionSelector::last ( Context &  refCtxt ) const

override

Access last item in the iteration.

Parameters

refCtxt

[IN/OUT] Reference to the Context object.

Returns

StatusCode indicating success or failure

Definition at line 377 of file EventCollectionSelector.cpp.

{
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::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 267 of file EventCollectionSelector.cpp.

{
  return next(refCtxt, 1);
}

StatusCode EventCollectionSelector::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 274 of file EventCollectionSelector.cpp.

{
  MyContextType *ctxt  = dynamic_cast<MyContextType*>(&refCtxt);
  if ( ctxt )    {
    *(ctxt->item) = ctxt->addressBuffer;
    StatusCode sc = StatusCode::SUCCESS;
    for ( int i=0; i<jump && sc.isSuccess(); ++i ) {
      sc = getNextRecord(ctxt->tuple);
    }
    return sc;
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::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 290 of file EventCollectionSelector.cpp.

{
  return previous(refCtxt, 1);
}

StatusCode EventCollectionSelector::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 297 of file EventCollectionSelector.cpp.

{
  MyContextType *ctxt  = dynamic_cast<MyContextType*>(&refCtxt);
  if ( ctxt )    {
    *(ctxt->item) = ctxt->addressBuffer;
    StatusCode sc = StatusCode::SUCCESS;
    for ( int i=0; i<jump && sc.isSuccess(); ++i ) {
      sc = getPreviousRecord(ctxt->tuple);
    }
    return sc;
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::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 351 of file EventCollectionSelector.cpp.

{
  MyContextType *ctxt  = dynamic_cast<MyContextType*>(refCtxt);
  if ( ctxt )   {
    delete ctxt;
    ctxt = nullptr;
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::resetCriteria ( const std::string &  cr, Context &  refCtxt  ) 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.

Returns

StatusCode indicating success or failure

Definition at line 365 of file EventCollectionSelector.cpp.

{
  MyContextType *ctxt  = dynamic_cast<MyContextType*>(&refCtxt);
  if ( ctxt )   {
    ctxt->criteria = cr;
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

StatusCode EventCollectionSelector::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 313 of file EventCollectionSelector.cpp.

{
  return StatusCode::FAILURE;
}

Member Data Documentation

std::string EventCollectionSelector::m_authentication

protected

Authentication string (if needed)

Definition at line 84 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_cntName

protected

Container name.

Definition at line 86 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_criteria

protected

Criteria.

Definition at line 90 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_database

protected

Datafile name.

Definition at line 92 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_dbSvc

protected

Database service (exclusive property with db type)

Definition at line 96 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_dbType

protected

Database type identifier.

Definition at line 94 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_itemName

protected

Item name.

Definition at line 88 of file EventCollectionSelector.h.

SmartIF<IAddressCreator> EventCollectionSelector::m_pAddrCreator

mutableprotected

Definition at line 80 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_statement

protected

Selector name.

Definition at line 98 of file EventCollectionSelector.h.

SmartIF<INTupleSvc> EventCollectionSelector::m_tupleSvc

mutableprotected

Reference to Tuple service.

Definition at line 79 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_tupleSvcName

protected

Name of the event collection service name.

Definition at line 82 of file EventCollectionSelector.h.

---

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

• GaudiCoreSvc/src/EventSelector/EventCollectionSelector.h
• GaudiCoreSvc/src/EventSelector/EventCollectionSelector.cpp