Definition of class EventSelector. More...

#include </builds/gaudi/Gaudi/GaudiCoreSvc/src/EventSelector/EventSelector.h>

Inheritance diagram for EventSelector:

[legend]

Collaboration diagram for EventSelector:

[legend]

Public Types
typedef std::vector< EventSelectorDataStream * >	Streams

typedef std::vector< std::string >	StreamSpecs

typedef std::vector< Gaudi::Property< std::string > >	Properties

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

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

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

StatusCode	reinitialize () override
	Service override: Reinitialize 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 &c) const override
	Access last item in the iteration. More...

StatusCode	firstOfNextStream (bool shutDown, EvtSelectorContext &it) const
	Retrieve first entry of the next data stream. More...

StatusCode	lastOfPreviousStream (bool shutDown, EvtSelectorContext &it) const
	Retrieve last entry of the previous data stream. 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...

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

StatusCode	setProperties ()

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 >
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, 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, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular 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...

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	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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...

Public Attributes
long int	m_streamID

Protected Member Functions
virtual void	printEvtInfo (const EvtSelectorContext *iter) const
	Progress report. More...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

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

Protected Attributes
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Reference to the indicent service. More...

SmartIF< IToolSvc >	m_toolSvc = nullptr

IDataStreamTool *	m_streamtool = nullptr

bool	m_reconfigure = false
	Reconfigure occurred. More...

StreamSpecs	m_streamSpecsLast
	Input stream specifiers (last used) More...

Streams	m_streams
	Input streams. More...

int	m_streamCount = 0
	Input stream counter (0..oo, monotonely increasing) More...

Gaudi::Property< StreamSpecs >	m_streamSpecs {this, "Input", {}, "input stream specifiers (for job options)"}

Gaudi::Property< int >	m_firstEvent {this, "FirstEvent", 0, "first event to be processed"}

Gaudi::Property< int >	m_evtMax {this, "EvtMax", INT_MAX, "maximum number of events to be processed"}

Gaudi::Property< int >	m_evtPrintFrequency {this, "PrintFreq", 10, "printout frequency"}

Gaudi::Property< std::string >	m_streamManager {this, "StreamManager", "DataStreamTool", ""}

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_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}

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 {this, "AutoRetrieveTools", true, "retrieve all AlgTools during initialize"}

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition of class EventSelector.

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 | +------—+-------------------------------------------—+---------—+ | 4/09/09 | Added firing incident on opening/ending file | R. Lambert | +------—+-------------------------------------------—+---------—+

Author: Markus Frank; R. Lambert

Version: 1.0

Definition at line 63 of file EventSelector.h.

Member Typedef Documentation

◆ Properties

typedef std::vector<Gaudi::Property<std::string> > EventSelector::Properties

Definition at line 67 of file EventSelector.h.

◆ Streams

typedef std::vector<EventSelectorDataStream*> EventSelector::Streams

Definition at line 65 of file EventSelector.h.

◆ StreamSpecs

typedef std::vector<std::string> EventSelector::StreamSpecs

Definition at line 66 of file EventSelector.h.

Member Function Documentation

◆ createAddress()

StatusCode EventSelector::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 281 of file EventSelector.cpp.

                                                                                                  {
   auto cpIt     = dynamic_cast<const EvtSelectorContext*>( &refCtxt );
   auto pIt      = const_cast<EvtSelectorContext*>( cpIt );
   refpAddr      = nullptr;
   StatusCode sc = StatusCode::FAILURE;
   if ( pIt ) {
     auto s   = m_streamtool->getStream( pIt->ID() );
     auto it  = pIt->context();
     auto sel = s->selector();
     if ( it && sel ) {
       IOpaqueAddress* pAddr = nullptr;
       sc                    = sel->createAddress( *it, pAddr );
       if ( sc.isSuccess() ) { refpAddr = pAddr; }
       pIt->set( it, pAddr );
     }
   }
   return sc;
 }

◆ createContext()

StatusCode EventSelector::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 161 of file EventSelector.cpp.

                                                                   {
   // Max event is zero. Return begin = end
   refpCtxt = nullptr;
   if ( m_firstEvent < 0 ) {
     error() << "First Event = " << m_firstEvent << " not valid" << endmsg;
     error() << "It should be > 0 " << endmsg;
     return StatusCode::FAILURE; // if failure => iterators = end();
   }
   auto ctxt = new EvtSelectorContext( this );
   refpCtxt  = ctxt;
   ctxt->set( 0, -1, 0, 0 );
   firstOfNextStream( true, *ctxt ).ignore();
   long nskip = m_firstEvent;
   while ( --nskip > 0 ) {
     StatusCode sc = next( *refpCtxt );
     if ( sc.isFailure() ) {
       error() << " createContext() failed to start with event number " << m_firstEvent << endmsg;
       if ( sc = releaseContext( refpCtxt ); !sc ) return sc;
       refpCtxt = nullptr;
       return StatusCode::FAILURE;
     }
   }
   return StatusCode::SUCCESS;
 }

◆ finalize()

StatusCode EventSelector::finalize ( )

override

IService implementation: Service finalization.

Definition at line 389 of file EventSelector.cpp.

                                    {
  
   if ( msgLevel( MSG::DEBUG ) ) { debug() << "finalize()" << endmsg; }
  
   m_incidentSvc = nullptr;
  
   if ( m_streamtool ) {
     if ( m_toolSvc ) {
       m_toolSvc->releaseTool( m_streamtool ).ignore();
     } else {
       // It should not be possible to get here
       m_streamtool->release();
     }
     m_streamtool = nullptr;
   }
   m_toolSvc.reset();
  
   return Service::finalize();
 }

◆ firstOfNextStream()

StatusCode EventSelector::firstOfNextStream	(	bool	shutDown,
		EvtSelectorContext &	it
	)		const

Retrieve first entry of the next data stream.

Definition at line 53 of file EventSelector.cpp.

                                                                                            {
   StatusCode                 status  = StatusCode::SUCCESS;
   IDataStreamTool::size_type iter_id = ( m_reconfigure ) ? 0 : iter.ID() + 1;
   if ( m_reconfigure ) const_cast<EventSelector*>( this )->m_reconfigure = false;
   if ( shutDown ) {
     if ( iter.ID() >= 0 && iter.ID() < (long)m_streamtool->size() ) {
       const EventSelectorDataStream* s = m_streamtool->getStream( iter.ID() );
       if ( s->isInitialized() ) {
         EventSelector* thisPtr = const_cast<EventSelector*>( this );
         if ( s->selector() && iter.context() ) {
           Context* ctxt = iter.context();
           s->selector()->releaseContext( ctxt ).ignore();
           iter.set( 0, 0 );
         }
         status = thisPtr->m_streamtool->finalizeStream( const_cast<EventSelectorDataStream*>( s ) );
         iter.set( 0, 0 );
       }
     }
   }
  
   const EventSelectorDataStream* s = nullptr;
   status                           = m_streamtool->getNextStream( s, iter_id );
  
   if ( status.isSuccess() ) {
  
     if ( s ) {
       if ( !s->isInitialized() ) {
         EventSelector* thisPtr = const_cast<EventSelector*>( this );
         status                 = thisPtr->m_streamtool->initializeStream( const_cast<EventSelectorDataStream*>( s ) );
       }
  
       if ( status.isSuccess() ) {
         const IEvtSelector* sel = s->selector();
         if ( sel ) {
           Context* ctxt = nullptr;
           status        = sel->createContext( ctxt );
           if ( status.isSuccess() ) {
             status = sel->resetCriteria( s->criteria(), *ctxt );
             if ( status.isSuccess() ) {
               iter.set( this, iter_id, ctxt, 0 );
               info() << *s << endmsg;
               m_incidentSvc->fireIncident( Incident( s->dbName(), IncidentType::BeginInputFile ) );
               return StatusCode::SUCCESS;
             }
           }
           delete ctxt;
         }
       }
       m_incidentSvc->fireIncident( Incident( s->dbName(), IncidentType::FailInputFile ) );
     }
   }
  
   iter.set( this, -1, 0, 0 );
   // m_incidentSvc->fireIncident(Incident(s->dbName(),IncidentType::FailInputFile));
   return StatusCode::FAILURE;
 }

◆ initialize()

StatusCode EventSelector::initialize ( )

override

IService implementation: Db event selector override.

Definition at line 316 of file EventSelector.cpp.

                                      {
   // Initialize base class
   StatusCode status = Service::initialize();
   if ( !status.isSuccess() ) {
     error() << "Error initializing base class Service!" << endmsg;
     return status;
   }
   // Get the references to the services that are needed by the ApplicationMgr itself
   m_incidentSvc = serviceLocator()->service( "IncidentSvc" );
   if ( !m_incidentSvc ) {
     fatal() << "Error retrieving IncidentSvc." << endmsg;
     return StatusCode::FAILURE;
   }
   if ( m_evtMax != INT_MAX ) {
     error() << "EvtMax is an obsolete property of the event selector." << endmsg;
     error() << "Please set \"ApplicationMgr.EvtMax = " << m_evtMax << ";\" to process the requested number of events."
             << endmsg;
     return StatusCode::FAILURE;
   }
  
   m_toolSvc = serviceLocator()->service( "ToolSvc" );
   if ( !m_toolSvc ) {
     error() << " Could not locate the Tool Service! " << endmsg;
     return StatusCode::FAILURE;
   }
   // make sure we finalize _prior_ to ToolSvc... we are about to get a
   // a pointer to a tool which gets finalized and released by the ToolSvc
   // during ToolSvc::finalize, and we don't want dangling pointers...
   SmartIF<ISvcManager> mgr( serviceLocator() );
   auto                 prio = mgr->getPriority( "ToolSvc" );
   mgr->setPriority( name(), prio + 1 ).ignore();
  
   status = m_toolSvc->retrieveTool( m_streamManager, m_streamtool, this );
  
   if ( status.isFailure() ) {
     error() << "Error initializing " << m_streamManager << endmsg;
     return status;
   }
  
   status = m_streamtool->clear();
   if ( status.isFailure() ) {
     // Message already printed by the tool
     return status;
   }
  
   status = m_streamtool->addStreams( m_streamSpecs );
  
   m_streamSpecsLast = m_streamSpecs;
  
   m_streamID = 0;
  
   return status;
 }

◆ last()

StatusCode EventSelector::last ( Context & c ) const

override

Access last item in the iteration.

Parameters

c	Reference to the Context object.

Returns: StatusCode indicating success or failure

Definition at line 258 of file EventSelector.cpp.

                                                        {
   EvtSelectorContext* pIt = dynamic_cast<EvtSelectorContext*>( &refCtxt );
   if ( pIt ) {}
   return StatusCode::FAILURE;
 }

◆ lastOfPreviousStream()

StatusCode EventSelector::lastOfPreviousStream	(	bool	shutDown,
		EvtSelectorContext &	it
	)		const

Retrieve last entry of the previous data stream.

Definition at line 111 of file EventSelector.cpp.

                                                                                               {
   StatusCode status = StatusCode::SUCCESS;
   if ( shutDown ) {
     if ( iter.ID() >= 0 && iter.ID() < (long)m_streamtool->size() ) {
       const EventSelectorDataStream* s = m_streamtool->getStream( iter.ID() );
       if ( s->isInitialized() ) {
         EventSelector* thisPtr = const_cast<EventSelector*>( this );
         if ( s->selector() && iter.context() ) {
           Context* ctxt = iter.context();
           if ( status = s->selector()->releaseContext( ctxt ); !status ) return status;
           iter.set( 0, 0 );
         }
         status = thisPtr->m_streamtool->finalizeStream( const_cast<EventSelectorDataStream*>( s ) );
         iter.set( 0, 0 );
       }
     }
   }
  
   IDataStreamTool::size_type     iter_id = iter.ID() - 1;
   const EventSelectorDataStream* s       = nullptr;
   status                                 = m_streamtool->getPreviousStream( s, iter_id );
  
   if ( status.isSuccess() ) {
  
     if ( !s->isInitialized() ) {
       EventSelector* thisPtr = const_cast<EventSelector*>( this );
       status                 = thisPtr->m_streamtool->initializeStream( const_cast<EventSelectorDataStream*>( s ) );
     }
     if ( status.isSuccess() ) {
       const IEvtSelector* sel = s->selector();
       if ( sel ) {
         Context* ctxt = nullptr;
         status        = sel->createContext( ctxt );
         if ( status.isSuccess() ) {
           status = sel->resetCriteria( s->criteria(), *ctxt );
           if ( status.isSuccess() ) {
             iter.set( this, iter_id, ctxt, 0 );
             info() << *s << endmsg;
             return StatusCode::SUCCESS;
           }
         }
       }
     }
   }
  
   iter.set( this, -1, 0, 0 );
   return StatusCode::FAILURE;
 }

◆ next() [1/2]

StatusCode EventSelector::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 187 of file EventSelector.cpp.

187 { return next( refCtxt, 1 ); }

◆ next() [2/2]

StatusCode EventSelector::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 190 of file EventSelector.cpp.

                                                               {
   EvtSelectorContext* pIt = dynamic_cast<EvtSelectorContext*>( &refCtxt );
   if ( pIt ) {
     if ( pIt->ID() != -1 ) {
       const EventSelectorDataStream* s   = m_streamtool->getStream( pIt->ID() );
       Context*                       it  = pIt->context();
       IEvtSelector*                  sel = s->selector();
       if ( it && sel ) {                  // First exploit the current stream
         StatusCode sc = sel->next( *it ); // This stream is empty: advance to the next stream
         if ( !sc.isSuccess() ) {
           m_incidentSvc->fireIncident( Incident( s->dbName(), IncidentType::EndInputFile ) );
           sc = firstOfNextStream( true, *pIt );
           if ( sc.isSuccess() ) sc = next( *pIt );
         } else {
           pIt->increaseCounters( false );
           pIt->set( it, 0 );
           printEvtInfo( pIt );
         }
         return sc;
       } else if ( m_reconfigure ) {
         StatusCode sc = firstOfNextStream( false, *pIt );
         printEvtInfo( pIt );
         return sc;
       }
     } else if ( m_reconfigure ) {
       StatusCode sc = firstOfNextStream( false, *pIt );
       printEvtInfo( pIt );
       return sc;
     }
     pIt->increaseCounters( false );
   }
   printEvtInfo( pIt );
   return StatusCode::FAILURE;
 }

◆ previous() [1/2]

StatusCode EventSelector::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 226 of file EventSelector.cpp.

226 { return previous( refCtxt, 1 ); }

◆ previous() [2/2]

StatusCode EventSelector::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 229 of file EventSelector.cpp.

                                                                      {
   EvtSelectorContext* pIt = dynamic_cast<EvtSelectorContext*>( &refCtxt );
   if ( pIt && jump > 0 ) {
     StatusCode sc = StatusCode::SUCCESS;
     for ( int i = 0; i < jump && sc.isSuccess(); ++i ) {
       const EventSelectorDataStream* s   = m_streamtool->getStream( pIt->ID() );
       Context*                       it  = pIt->context();
       IEvtSelector*                  sel = s->selector();
       if ( it && sel ) {           // First exploit the current stream
                                    // This stream is empty: advance to the next stream
         sc = sel->previous( *it ); // This stream is empty: advance to the next stream
         if ( !sc.isSuccess() ) {
           sc = lastOfPreviousStream( true, *pIt );
         } else {
           pIt->increaseCounters( false );
           pIt->set( it, 0 );
         }
         printEvtInfo( pIt );
         if ( !sc.isSuccess() ) { return sc; }
       }
       pIt->increaseCounters( false );
     }
     return sc;
   }
   printEvtInfo( pIt );
   return StatusCode::FAILURE;
 }

◆ printEvtInfo()

void EventSelector::printEvtInfo ( const EvtSelectorContext * iter ) const

protectedvirtual

Progress report.

Definition at line 35 of file EventSelector.cpp.

                                                                        {
   if ( iter ) {
     long count = iter->numEvent();
     // Print an message every m_evtPrintFrequency events
     if ( 0 == iter->context() ) {
       info() << "End of event input reached." << endmsg;
     } else if ( iter->numStreamEvent() == -1 ) {
       // Intial value for this stream
     } else if ( m_evtPrintFrequency != -1 && ( count % m_evtPrintFrequency == 0 ) ) {
       always() << "Reading Event record " << count + 1 << ". Record number within stream " << iter->ID() + 1 << ": "
                << iter->numStreamEvent() + 1 << endmsg;
     }
   } else {
     info() << "End of event input reached." << endmsg;
   }
 }

◆ reinitialize()

StatusCode EventSelector::reinitialize ( )

override

Service override: Reinitialize service.

Definition at line 371 of file EventSelector.cpp.

                                        {
   if ( FSMState() != Gaudi::StateMachine::INITIALIZED ) {
     error() << "Cannot reinitialize: service not in state initialized" << endmsg;
     return StatusCode::FAILURE;
   }
  
   if ( m_streamSpecsLast != m_streamSpecs ) {
     StatusCode status = m_streamtool->clear();
     if ( status.isFailure() ) return status;
     m_streamSpecsLast = m_streamSpecs;
     m_reconfigure     = true;
     return m_streamtool->addStreams( m_streamSpecs );
   }
  
   return StatusCode::SUCCESS;
 }

◆ releaseContext()

StatusCode EventSelector::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 301 of file EventSelector.cpp.

                                                                   {
   StatusCode                          sc   = StatusCode::SUCCESS;
   auto                                cpIt = dynamic_cast<const EvtSelectorContext*>( refCtxt );
   std::unique_ptr<EvtSelectorContext> pIt{const_cast<EvtSelectorContext*>( cpIt )};
   if ( pIt && pIt->ID() >= 0 && pIt->ID() < (long)m_streamtool->size() ) {
     const auto s   = m_streamtool->getStream( pIt->ID() );
     auto       it  = pIt->context();
     auto       sel = s->selector();
     if ( it && sel ) { sc = sel->releaseContext( it ); }
   }
   refCtxt = nullptr; // std::unique_ptr always deletes object, so always set to NULL
   return sc;
 }

◆ resetCriteria()

StatusCode EventSelector::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.

Returns: StatusCode indicating success or failure

Definition at line 30 of file EventSelector.cpp.

                                                                               {
   return StatusCode::FAILURE;
 }

◆ rewind()

StatusCode EventSelector::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 265 of file EventSelector.cpp.

                                                          {
   StatusCode          sc   = StatusCode::SUCCESS;
   EvtSelectorContext* ctxt = dynamic_cast<EvtSelectorContext*>( &refCtxt );
   if ( ctxt ) {
     ctxt->set( 0, -1, 0, 0 );
     if ( sc = firstOfNextStream( true, *ctxt ); !sc ) return sc;
     long nskip = m_firstEvent;
     while ( --nskip > 0 ) {
       sc = next( *ctxt );
       if ( sc.isFailure() ) { error() << "rewind() failed to start with event number " << m_firstEvent << endmsg; }
     }
   }
   return sc;
 }

Member Data Documentation

◆ m_evtMax

Gaudi::Property<int> EventSelector::m_evtMax {this, "EvtMax", INT_MAX, "maximum number of events to be processed"}

protected

Definition at line 91 of file EventSelector.h.

◆ m_evtPrintFrequency

Gaudi::Property<int> EventSelector::m_evtPrintFrequency {this, "PrintFreq", 10, "printout frequency"}

protected

Definition at line 92 of file EventSelector.h.

◆ m_firstEvent

Gaudi::Property<int> EventSelector::m_firstEvent {this, "FirstEvent", 0, "first event to be processed"}

protected

Definition at line 90 of file EventSelector.h.

◆ m_incidentSvc

SmartIF<IIncidentSvc> EventSelector::m_incidentSvc = nullptr

protected

Reference to the indicent service.

Definition at line 73 of file EventSelector.h.

◆ m_reconfigure

bool EventSelector::m_reconfigure = false

protected

Reconfigure occurred.

Definition at line 80 of file EventSelector.h.

◆ m_streamCount

int EventSelector::m_streamCount = 0

protected

Input stream counter (0..oo, monotonely increasing)

Definition at line 86 of file EventSelector.h.

◆ m_streamID

long int EventSelector::m_streamID

Definition at line 69 of file EventSelector.h.

◆ m_streamManager

Gaudi::Property<std::string> EventSelector::m_streamManager {this, "StreamManager", "DataStreamTool", ""}

protected

Definition at line 93 of file EventSelector.h.

◆ m_streams

Streams EventSelector::m_streams

protected

Input streams.

Definition at line 84 of file EventSelector.h.

◆ m_streamSpecs

Gaudi::Property<StreamSpecs> EventSelector::m_streamSpecs {this, "Input", {}, "input stream specifiers (for job options)"}

protected

Definition at line 89 of file EventSelector.h.

◆ m_streamSpecsLast

StreamSpecs EventSelector::m_streamSpecsLast

protected

Input stream specifiers (last used)

Definition at line 82 of file EventSelector.h.

◆ m_streamtool

IDataStreamTool* EventSelector::m_streamtool = nullptr

protected

Definition at line 77 of file EventSelector.h.

◆ m_toolSvc

SmartIF<IToolSvc> EventSelector::m_toolSvc = nullptr

protected

Definition at line 75 of file EventSelector.h.

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

GaudiCoreSvc/src/EventSelector/EventSelector.h
GaudiCoreSvc/src/EventSelector/EventSelector.cpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Properties

◆ Streams

◆ StreamSpecs

Member Function Documentation

◆ createAddress()

◆ createContext()

◆ finalize()

◆ firstOfNextStream()

◆ initialize()

◆ last()

◆ lastOfPreviousStream()

◆ next() [1/2]

◆ next() [2/2]

◆ previous() [1/2]

◆ previous() [2/2]

◆ printEvtInfo()

◆ reinitialize()

◆ releaseContext()

◆ resetCriteria()

◆ rewind()

Member Data Documentation

◆ m_evtMax

◆ m_evtPrintFrequency

◆ m_firstEvent

◆ m_incidentSvc

◆ m_reconfigure

◆ m_streamCount

◆ m_streamID

◆ m_streamManager

◆ m_streams

◆ m_streamSpecs

◆ m_streamSpecsLast

◆ m_streamtool

◆ m_toolSvc