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< Service, IEvtSelector >
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 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...
StatusCode	setProperty (const Property &p) override
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
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const T *&psvc, 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 &name, T *&psvc, bool createIf=true) const
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
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 >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
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...

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...
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * >	Factory
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
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. 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 75 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 218 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 112 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 153 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 133 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;
    error() << "Item " << itName << " is not part of the collection:" << top << endmsg;
    delete item;
    item = nullptr;
  }
  else  {
    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 315 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    {
        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 247 of file EventCollectionSelector.cpp.

{
  refpCtxt = nullptr;
  std::unique_ptr<MyContextType> ctxt(new MyContextType());
  StatusCode status = connectCollection(ctxt.get());
  if( !status.isSuccess() )  {
    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 238 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 169 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 187 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 90 of file EventCollectionSelector.cpp.

                                                  {
  // Initialize base class
  StatusCode status = Service::initialize();
  if ( !status.isSuccess() )    {
    error() << "Error initializing base class Service!" << endmsg;
    return status;
  }
  m_pAddrCreator = serviceLocator()->service("EventPersistencySvc");
  if(!m_pAddrCreator) {
    error() << "Unable to locate IAddressCreator interface of " << "EventPersistencySvc" << endmsg;
    return status;
  }
  m_tupleSvc = serviceLocator()->service(m_tupleSvcName);
  if( !m_tupleSvc )   {
    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 371 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 262 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 269 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 285 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 292 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 345 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 359 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 308 of file EventCollectionSelector.cpp.

{
  return StatusCode::FAILURE;
}

Member Data Documentation

std::string EventCollectionSelector::m_authentication

protected

Authentication string (if needed)

Definition at line 85 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_cntName

protected

Container name.

Definition at line 87 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_criteria

protected

Criteria.

Definition at line 91 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_database

protected

Datafile name.

Definition at line 93 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_dbSvc

protected

Database service (exclusive property with db type)

Definition at line 97 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_dbType

protected

Database type identifier.

Definition at line 95 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_itemName

protected

Item name.

Definition at line 89 of file EventCollectionSelector.h.

SmartIF<IAddressCreator> EventCollectionSelector::m_pAddrCreator

mutableprotected

Definition at line 81 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_statement

protected

Selector name.

Definition at line 99 of file EventCollectionSelector.h.

SmartIF<INTupleSvc> EventCollectionSelector::m_tupleSvc

mutableprotected

Reference to Tuple service.

Definition at line 80 of file EventCollectionSelector.h.

std::string EventCollectionSelector::m_tupleSvcName

protected

Name of the event collection service name.

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