Auxiliary class to synchronously read DAQ events and Monte Carlo events (and optionally other events). More...

#include <JTriggeredFileScanner.hh>

Inheritance diagram for JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >:

Public Types
typedef JTypeList< JDAQEvent, JTypelist_t >	typelist

typedef JParallelFileScanner< typelist, JFileScanner_t >	parallel_filescannner_type

typedef JMultiPointer< JTypeList< Evt, typelist > >	multi_pointer_type

typedef JMultipleFileScanner< JNullType >::input_type	input_type

typedef JRewindableObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JTriggeredFileScanner ()
	Default constructor. More...

	JTriggeredFileScanner (const typename parallel_filescannner_type::input_type &input)
	Constructor. More...

	JTriggeredFileScanner (const typename parallel_filescannner_type::input_type &input, const JLimit &limit)
	Constructor. More...

virtual bool	hasNext () override
	Check availability of next element. More...

virtual const multi_pointer_type &	next () override
	Get next element. More...

const std::string &	getFilename () const
	Get current file name. More...

counter_type	getCounter () const
	Get counter. More...

virtual void	rewind () override
	Rewind. More...

virtual skip_type	skip (const skip_type ns) override
	Skip items. More...

virtual skip_type	skip (const skip_type ns)
	Skip items. More...

Protected Attributes
JTreeScanner< Evt >	in

std::string	file_name

JFileScanner< T >	scanner

unsigned int	index

counter_type	counter

Private Attributes
multi_pointer_type	ps

Detailed Description

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>
struct JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >

Auxiliary class to synchronously read DAQ events and Monte Carlo events (and optionally other events).

It is assumed that the TTree corresponding to the template argument and the TTree with KM3NETDAQ::JDAQEvent can be read in parallel.

Definition at line 39 of file JTriggeredFileScanner.hh.

Member Typedef Documentation

◆ typelist

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

typedef JTypeList<JDAQEvent, JTypelist_t> JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::typelist

Definition at line 42 of file JTriggeredFileScanner.hh.

◆ parallel_filescannner_type

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

typedef JParallelFileScanner<typelist, JFileScanner_t> JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::parallel_filescannner_type

Definition at line 43 of file JTriggeredFileScanner.hh.

◆ multi_pointer_type

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

typedef JMultiPointer< JTypeList<Evt, typelist> > JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::multi_pointer_type

Definition at line 44 of file JTriggeredFileScanner.hh.

◆ input_type

typedef JMultipleFileScanner <JNullType>::input_type JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType > , JMultipleFileScanner >::input_type

inherited

Definition at line 38 of file JParallelFileScanner.hh.

◆ pointer_type

template<class T >

typedef JRewindableObjectIterator<T>::pointer_type JSUPPORT::JMultipleFileScanner< T >::pointer_type

inherited

Definition at line 310 of file JMultipleFileScanner.hh.

Constructor & Destructor Documentation

◆ JTriggeredFileScanner() [1/3]

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::JTriggeredFileScanner ( )

inline

Default constructor.

Definition at line 50 of file JTriggeredFileScanner.hh.

                             :
       parallel_filescannner_type()
     {}

◆ JTriggeredFileScanner() [2/3]

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::JTriggeredFileScanner ( const typename parallel_filescannner_type::input_type & input )

inline

Constructor.

Parameters

input input

Definition at line 60 of file JTriggeredFileScanner.hh.

     {
       this->configure(input, JLimit());
     }

◆ JTriggeredFileScanner() [3/3]

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::JTriggeredFileScanner	(	const typename parallel_filescannner_type::input_type &	input,
		const JLimit &	limit
	)

inline

Constructor.

Parameters

input	input
limit	limit

Definition at line 72 of file JTriggeredFileScanner.hh.

     {
       this->configure(input, limit);
     }

Member Function Documentation

◆ hasNext()

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

virtual bool JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::hasNext ( )

inlineoverridevirtual

Check availability of next element.

Returns: true if the iteration has more elements; else false

Reimplemented from JSUPPORT::JMultipleFileScanner< T >.

Definition at line 83 of file JTriggeredFileScanner.hh.

     {
       bool has_next = parallel_filescannner_type::hasNext();
       
       if (has_next && file_name != this->getFilename()) {
  
         in.configure(this->getFilename());
  
         file_name =  this->getFilename();
       }
       
       return has_next;
     }

◆ next()

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

virtual const multi_pointer_type& JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::next ( )

inlineoverridevirtual

Get next element.

Returns: multi-pointer to elements

Reimplemented from JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType >, JMultipleFileScanner >.

Definition at line 103 of file JTriggeredFileScanner.hh.

     {
       static multi_pointer_type ps;
       
       typename parallel_filescannner_type::multi_pointer_type __p = parallel_filescannner_type::next();
       
       JDAQEvent* tev   = __p;
       Evt*       event = in.getEntry(tev->getCounter());
  
       ps.reset(event, __p);
  
       return ps;
     }

◆ getFilename()

template<class T >

const std::string& JSUPPORT::JMultipleFileScanner< T >::getFilename ( ) const

inlineinherited

Get current file name.

Note that this method should only be called when method hasNext() returns true.

Returns: file name

Definition at line 371 of file JMultipleFileScanner.hh.

     {
       return this->at(index);
     }

◆ getCounter()

template<class T >

counter_type JSUPPORT::JMultipleFileScanner< T >::getCounter ( ) const

inlineinherited

Get counter.

Returns: counter

Definition at line 382 of file JMultipleFileScanner.hh.

     {
       return counter;
     }

◆ rewind()

template<class T >

virtual void JSUPPORT::JMultipleFileScanner< T >::rewind ( )

inlineoverridevirtualinherited

Rewind.

Implements JLANG::JRewindable< T >.

Reimplemented in JSUPPORT::JMultipleFileScanner< JTriggerParameters >, JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >, and JSUPPORT::JMultipleFileScanner< Head >.

Definition at line 391 of file JMultipleFileScanner.hh.

     {
       if (scanner.is_open()) {
         scanner.close();
       }
  
       index   = 0;
       counter = 0;
  
       scanner.reset();
     }

◆ skip() [1/2]

template<class T >

virtual skip_type JSUPPORT::JMultipleFileScanner< T >::skip ( const skip_type ns )

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

Reimplemented in JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >.

Definition at line 471 of file JMultipleFileScanner.hh.

     {
       skip_type i = 0;
  
       while (this->hasNext() && i != ns) {
         i += scanner.skip(ns - i);
       }
  
       counter += i;
  
       return i;
     }

◆ skip() [2/2]

template<class T >

virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type ns )

inlinevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

Reimplemented in JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

     {
       skip_type i = 0;
  
       for ( ; i != ns && hasNext(); ++i) {
         next();
       }
  
       return i;
     }

Member Data Documentation

◆ in

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

JTreeScanner<Evt> JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::in

protected

Definition at line 118 of file JTriggeredFileScanner.hh.

◆ file_name

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>

std::string JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >::file_name

protected

Definition at line 119 of file JTriggeredFileScanner.hh.

◆ ps

multi_pointer_type JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType > , JMultipleFileScanner >::ps

privateinherited

Definition at line 85 of file JParallelFileScanner.hh.

◆ scanner

template<class T >

JFileScanner<T> JSUPPORT::JMultipleFileScanner< T >::scanner

protectedinherited

Definition at line 486 of file JMultipleFileScanner.hh.

◆ index

template<class T >

unsigned int JSUPPORT::JMultipleFileScanner< T >::index

protectedinherited

Definition at line 487 of file JMultipleFileScanner.hh.

◆ counter

template<class T >

counter_type JSUPPORT::JMultipleFileScanner< T >::counter

protectedinherited

Definition at line 488 of file JMultipleFileScanner.hh.

The documentation for this struct was generated from the following file:

JTriggeredFileScanner.hh

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner> struct JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >

Member Typedef Documentation

◆ typelist

◆ parallel_filescannner_type

◆ multi_pointer_type

◆ input_type

◆ pointer_type

Constructor & Destructor Documentation

◆ JTriggeredFileScanner() [1/3]

◆ JTriggeredFileScanner() [2/3]

◆ JTriggeredFileScanner() [3/3]

Member Function Documentation

◆ hasNext()

◆ next()

◆ getFilename()

◆ getCounter()

◆ rewind()

◆ skip() [1/2]

◆ skip() [2/2]

Member Data Documentation

◆ in

◆ file_name

◆ ps

◆ scanner

◆ index

◆ counter

template<class JTypelist_t = JNullType, template< class > class JFileScanner_t = JMultipleFileScanner>
struct JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >