Jpp - the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
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 >:
JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JTypelist_t >, JMultipleFileScanner > JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > > JLANG::JRewindableObjectIterator< T > JLANG::JObjectIterator< T > JLANG::JRewindable< 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)
 Constructor. More...
 
 JTriggeredFileScanner (const typename base_class::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< JTypeList
< JDAQEvent, JTypelist_t > > 		scanner
 
unsigned int index
 
counter_type counter
 

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

template<class JTypelist_t = JNullType>
typedef JTypeList<JDAQEvent, JTypelist_t> JSUPPORT::JTriggeredFileScanner< JTypelist_t >::typelist

Definition at line 42 of file JTriggeredFileScanner.hh.

template<class JTypelist_t = JNullType>
typedef JParallelFileScanner<typelist, JMultipleFileScanner> JSUPPORT::JTriggeredFileScanner< JTypelist_t >::base_class

Definition at line 43 of file JTriggeredFileScanner.hh.

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.

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

Definition at line 38 of file JParallelFileScanner.hh.

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

template<class JTypelist_t = JNullType>
JSUPPORT::JTriggeredFileScanner< JTypelist_t >::JTriggeredFileScanner ( )
inline

Default constructor.

Definition at line 50 of file JTriggeredFileScanner.hh.

50  :
51  base_class()
52  {}
JSUPPORT::JTriggeredFileScanner::base_class
JParallelFileScanner< typelist, JMultipleFileScanner > base_class
Definition: JTriggeredFileScanner.hh:43
template<class JTypelist_t = JNullType>
JSUPPORT::JTriggeredFileScanner< JTypelist_t >::JTriggeredFileScanner ( const typename base_class::input_type &  input)
inline

Constructor.

Parameters
inputinput

Definition at line 60 of file JTriggeredFileScanner.hh.

61  {
62  this->configure(input, JLimit());
63  }
JSUPPORT::JLimit
Auxiliary class for defining the range of iterations of objects.
Definition: JLimit.hh:41
JTOOLS::configure
void configure(const T &value, const JAbstractCollection< JAbscissa_t > &bounds, JBool< false > option)
Configuration of value.
Definition: JToolsToolkit.hh:285
template<class JTypelist_t = JNullType>
JSUPPORT::JTriggeredFileScanner< JTypelist_t >::JTriggeredFileScanner ( const typename base_class::input_type &  input,
const JLimit &  limit 
)
inline

Constructor.

Parameters
inputinput
limitlimit

Definition at line 72 of file JTriggeredFileScanner.hh.

73  {
74  this->configure(input, limit);
75  }
JTOOLS::configure
void configure(const T &value, const JAbstractCollection< JAbscissa_t > &bounds, JBool< false > option)
Configuration of value.
Definition: JToolsToolkit.hh:285

Member Function Documentation

template<class JTypelist_t = JNullType>
virtual bool JSUPPORT::JTriggeredFileScanner< JTypelist_t >::hasNext ( )
inlineoverridevirtual

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 83 of file JTriggeredFileScanner.hh.

84  {
85  bool has_next = base_class::hasNext();
86 
87  if (has_next && file_name != this->getFilename()) {
88 
89  in.configure(this->getFilename());
90 
91  file_name = this->getFilename();
92  }
93 
94  return has_next;
95  }
JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::getFilename
const std::string & getFilename() const
Get current file name.
Definition: JMultipleFileScanner.hh:325
template<class JTypelist_t = JNullType>
virtual const multi_pointer_type& JSUPPORT::JTriggeredFileScanner< JTypelist_t >::next ( )
inlineoverridevirtual

Get next element.

Returns
multi-pointer to elements

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

Definition at line 103 of file JTriggeredFileScanner.hh.

104  {
105  static multi_pointer_type ps;
106 
107  typename base_class::multi_pointer_type __p = base_class::next();
108 
109  JDAQEvent* tev = __p;
110  Evt* event = in.getEntry(tev->getCounter());
111 
112  ps.reset(event, __p);
113 
114  return ps;
115  }
JSUPPORT::JTriggeredFileScanner::multi_pointer_type
JMultiPointer< JTypeList< Evt, typelist > > multi_pointer_type
Definition: JTriggeredFileScanner.hh:44
JSUPPORT::JParallelFileScanner::next
virtual const multi_pointer_type & next() override
Get next element.
Definition: JParallelFileScanner.hh:77
KM3NETDAQ::JDAQTriggerCounter::getCounter
JTriggerCounter_t getCounter() const
Get trigger counter.
Definition: JDAQTriggerCounter.hh:99
Evt
The Evt class respresent a Monte Carlo (MC) event as well as an offline event.
Definition: Evt.hh:19
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 325 of file JMultipleFileScanner.hh.

326  {
327  return this->at(index);
328  }
counter_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::getCounter ( ) const
inlineinherited

Get counter.

Returns
counter

Definition at line 336 of file JMultipleFileScanner.hh.

337  {
338  return counter;
339  }
virtual void JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::rewind ( )
inlineoverridevirtualinherited

Rewind.

Implements JLANG::JRewindable< T >.

Definition at line 345 of file JMultipleFileScanner.hh.

346  {
347  if (scanner.is_open()) {
348  scanner.close();
349  }
350 
351  index = 0;
352  counter = 0;
353 
354  scanner.reset();
355  }
JLANG::JAbstractAccessibleObjectReader::is_open
virtual bool is_open() const override
Check is device is open.
Definition: JAbstractObjectReader.hh:137
JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::scanner
JFileScanner< JTypeList< JDAQEvent, JTypelist_t > > scanner
Definition: JMultipleFileScanner.hh:440
JLANG::JAbstractAccessibleObjectReader::close
virtual void close() override
Close device.
Definition: JAbstractObjectReader.hh:162
JLANG::JSharedPointer::reset
virtual void reset() override
Reset pointer.
Definition: JSharedPointer.hh:171
virtual skip_type JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::skip ( const skip_type  ns)
inlineoverridevirtualinherited

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Definition at line 425 of file JMultipleFileScanner.hh.

426  {
427  skip_type i = 0;
428 
429  while (this->hasNext() && i != ns) {
430  i += scanner.skip(ns - i);
431  }
432 
433  counter += i;
434 
435  return i;
436  }
JLANG::skip_type
unsigned int skip_type
Type definition for number of objects to skip.
Definition: JObjectIterator.hh:25
JLANG::JObjectIterator::skip
virtual skip_type skip(const skip_type ns)
Skip items.
Definition: JObjectIterator.hh:90
JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::hasNext
virtual bool hasNext() override
Check availability of next element.
Definition: JMultipleFileScanner.hh:363
JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JTypelist_t > >::scanner
JFileScanner< JTypeList< JDAQEvent, JTypelist_t > > scanner
Definition: JMultipleFileScanner.hh:440
template<class T>
virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type  ns)
inlinevirtualinherited

Skip items.

Parameters
nsnumber 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< JNullType >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::KM3NETDAQ::JDAQEvent >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, and JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 90 of file JObjectIterator.hh.

91  {
92  skip_type i = 0;
93 
94  for ( ; i != ns && hasNext(); ++i) {
95  next();
96  }
97 
98  return i;
99  }
JLANG::skip_type
unsigned int skip_type
Type definition for number of objects to skip.
Definition: JObjectIterator.hh:25
JLANG::JObjectIterator::next
virtual const pointer_type & next()=0
Get next element.
JLANG::JObjectIterator::hasNext
virtual bool hasNext()=0
Check availability of next element.

Member Data Documentation

template<class JTypelist_t = JNullType>
JTreeScanner<Evt> JSUPPORT::JTriggeredFileScanner< JTypelist_t >::in
protected

Definition at line 118 of file JTriggeredFileScanner.hh.

template<class JTypelist_t = JNullType>
std::string JSUPPORT::JTriggeredFileScanner< JTypelist_t >::file_name
protected

Definition at line 119 of file JTriggeredFileScanner.hh.

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

Definition at line 440 of file JMultipleFileScanner.hh.

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

Definition at line 441 of file JMultipleFileScanner.hh.

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

Definition at line 442 of file JMultipleFileScanner.hh.

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.5