JSUPPORT::JTriggeredFileScanner< JTypelist_t > Struct Template Reference

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

Public Types
typedef JTypeList< JDAQEvent, JTypelist_t >	typelist
typedef JParallelFileScanner< typelist, JMultipleFileScanner >	base_class
typedef JMultiPointer< JTypeList< Evt, typelist > >	multi_pointer_type
typedef JMultipleFileScanner< JNullType >::input_type	input_type
typedef JRewindableObjectIterator< JTypeList< JDAQEvent, JTypelist_t > >::pointer_type	pointer_type

Public Member Functions
	JTriggeredFileScanner ()
	Default constructor. More...
	JTriggeredFileScanner (const typename base_class::input_type &input, const JLimit &limit=JLimit())
	Constructor. More...
virtual bool	hasNext ()
	Check availability of next element. More...
virtual const multi_pointer_type &	next ()
	Get next element. More...
const std::string &	getFilename () const
	Get current file name. More...
counter_type	getCounter () const
	Get counter. More...
virtual void	rewind ()
	Rewind. More...
virtual skip_type	skip (const skip_type ns)
	Skip items. More...
virtual skip_type	skip (const skip_type ns)
	Skip items. More...

Protected Attributes
JTreeScanner< Evt >	in
std::string	file_name
JFileScanner< JTypeList< JDAQEvent, JTypelist_t > >	scanner
unsigned int	index
counter_type	counter

Private Attributes
multi_pointer_type	ps

Detailed Description

template<class JTypelist_t = JNullType>
struct JSUPPORT::JTriggeredFileScanner< JTypelist_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>

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

Definition at line 42 of file JTriggeredFileScanner.hh.

base_class

template<class JTypelist_t = JNullType>

typedef JParallelFileScanner<typelist, JMultipleFileScanner> JSUPPORT::JTriggeredFileScanner< JTypelist_t >::base_class

Definition at line 43 of file JTriggeredFileScanner.hh.

multi_pointer_type

template<class JTypelist_t = JNullType>

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

Definition at line 44 of file JTriggeredFileScanner.hh.

input_type

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

inherited

Definition at line 36 of file JParallelFileScanner.hh.

pointer_type

typedef JRewindableObjectIterator<JTypeList< JDAQEvent, JTypelist_t > >::pointer_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::pointer_type

inherited

Definition at line 264 of file JMultipleFileScanner.hh.

Constructor & Destructor Documentation

JTriggeredFileScanner() [1/2]

template<class JTypelist_t = JNullType>

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

inline

Default constructor.

Definition at line 50 of file JTriggeredFileScanner.hh.

                            :
      base_class()
    {}

JTriggeredFileScanner() [2/2]

template<class JTypelist_t = JNullType>

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

inline

Constructor.

Parameters

input	input
limit	limit

Definition at line 61 of file JTriggeredFileScanner.hh.

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

Member Function Documentation

hasNext()

template<class JTypelist_t = JNullType>

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

inlinevirtual

Check availability of next element.

Returns

true if the iteration has more elements; else false

Reimplemented from JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 72 of file JTriggeredFileScanner.hh.

    {
      bool has_next = base_class::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>

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

inlinevirtual

Get next element.

Returns

multi-pointer to elements

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

Definition at line 92 of file JTriggeredFileScanner.hh.

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

getFilename()

const std::string& JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_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 312 of file JMultipleFileScanner.hh.

    {
      return this->at(index);
    }

getCounter()

counter_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::getCounter ( ) const

inlineinherited

Get counter.

Returns

counter

Definition at line 323 of file JMultipleFileScanner.hh.

    {
      return counter;
    }

rewind()

virtual void JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::rewind ( )

inlinevirtualinherited

Rewind.

Implements JLANG::JRewindable< T >.

Definition at line 332 of file JMultipleFileScanner.hh.

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

skip() [1/2]

virtual skip_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::skip ( const skip_type  ns )

inlinevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

Definition at line 412 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::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JSTDObjectIterator< T >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, and JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JTypelist_t > >.

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

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

protected

Definition at line 107 of file JTriggeredFileScanner.hh.

file_name

template<class JTypelist_t = JNullType>

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

protected

Definition at line 108 of file JTriggeredFileScanner.hh.

ps

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

privateinherited

Definition at line 72 of file JParallelFileScanner.hh.

scanner

JFileScanner<JTypeList< JDAQEvent, JTypelist_t > > JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::scanner

protectedinherited

Definition at line 427 of file JMultipleFileScanner.hh.

index

unsigned int JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::index

protectedinherited

Definition at line 428 of file JMultipleFileScanner.hh.

counter

counter_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::counter

protectedinherited

Definition at line 429 of file JMultipleFileScanner.hh.

---

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

• JTriggeredFileScanner.hh