Template specialisation of JMultipleFileScanner for Monte Carlo header. More...

#include <JMonteCarloFileSupportkit.hh>

Inheritance diagram for JSUPPORT::JMultipleFileScanner< Head >:

Public Types
typedef JMultipleFileScanner ::input_type	input_type

typedef JRewindableObjectIterator< T >::pointer_type	pointer_type

typedef JObjectIterator< T >::pointer_type	pointer_type

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

	JMultipleFileScanner (const JMultipleFileScanner_t &file_list)
	Copy constructor. More...

virtual void	rewind ()
	Rewind. More...

virtual bool	setObject (Head &object)
	Set object. More...

const Head &	getHeader ()
	Get Monte Carlo Header. More...

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

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

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

virtual const pointer_type &	next ()
	Get next element. More...

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

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

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

virtual const pointer_type &	next ()
	Get next element. More...

virtual bool	setObject (T &object)=0
	Set object. More...

Static Public Attributes
static bool	merge = false
	Allow merging of files w/o header. More...

Protected Attributes
JFileScanner< T >	scanner

unsigned int	index

counter_type	counter

T	object
	object More...

bool	has_next
	status More...

Private Attributes
bool	do_next

pointer_type	ps

Detailed Description

template<>
class JSUPPORT::JMultipleFileScanner< Head >

Template specialisation of JMultipleFileScanner for Monte Carlo header.

This class re-implements the methods rewind and setObject of the JLANG::JRewindableAbstractObjectIterator interface so that all header objects in the complete file list are read and added. It provides for the method JSUPPORT::getHeader which returns the sum of all headers.

Definition at line 291 of file JMonteCarloFileSupportkit.hh.

Member Typedef Documentation

◆ input_type

typedef JMultipleFileScanner ::input_type JSUPPORT::JMultipleFileScanner< T >::input_type

inherited

Definition at line 263 of file JMultipleFileScanner.hh.

◆ pointer_type [1/2]

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

inherited

Definition at line 264 of file JMultipleFileScanner.hh.

◆ pointer_type [2/2]

template<class T>

typedef JObjectIterator<T>::pointer_type JLANG::JAbstractObjectIterator< T >::pointer_type

inherited

Definition at line 39 of file JAbstractObjectIterator.hh.

Constructor & Destructor Documentation

◆ JMultipleFileScanner() [1/2]

JSUPPORT::JMultipleFileScanner< Head >::JMultipleFileScanner ( )

inline

Default constructor.

Definition at line 299 of file JMonteCarloFileSupportkit.hh.

                            :
       JMultipleFileScanner<>(),
       JRewindableAbstractObjectIterator<Head>(),
       do_next(true)
     {}

◆ JMultipleFileScanner() [2/2]

JSUPPORT::JMultipleFileScanner< Head >::JMultipleFileScanner ( const JMultipleFileScanner_t & file_list )

inline

Copy constructor.

The file list is copied.

Parameters

file_list JMultipleFileScanner

Definition at line 312 of file JMonteCarloFileSupportkit.hh.

                                                                   :
       JMultipleFileScanner<>(),
       JRewindableAbstractObjectIterator<Head>(),
       do_next(true)
     {
       static_cast<JMultipleFileScanner_t&>(*this) = file_list;
     }

Member Function Documentation

◆ rewind()

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

inlinevirtual

Rewind.

Reimplemented from JSUPPORT::JMultipleFileScanner<>.

Definition at line 324 of file JMonteCarloFileSupportkit.hh.

     {
       do_next = true;
     }

◆ setObject() [1/2]

virtual bool JSUPPORT::JMultipleFileScanner< Head >::setObject ( Head & object )

inlinevirtual

Set object.

Parameters

object reference to object to be set

Returns: true if set; else false

Definition at line 336 of file JMonteCarloFileSupportkit.hh.

     {
       if (do_next) {
  
         using namespace JLANG;
  
         JHead header;
  
         do_next = false;
  
         unsigned int count = 0;
  
         JFileScanner<Head> scanner;
  
         for (const_iterator i = this->begin(); i != this->end(); ++i) {
           
           scanner.open(i->c_str());
  
           if (scanner.hasNext()) {
  
             const JHead buffer = *scanner.next();
  
             if      (count == 0)
               header  =  buffer;
             else if (header.match(buffer))
               header.add(buffer);
             else
               THROW(JException, "JMultipleFileScanner<Head>::setObject(): inconsistent headers.");
  
             ++count;
           }
           
           scanner.close();
         }
  
         copy(header, object);
  
         if (count != 0 && count != this->size()) {
           if (!merge) {
             THROW(JException, "JMultipleFileScanner<Head>::setObject(): missing header(s): " << count << " != " << this->size());
           }
         }
  
         return count != 0;
  
       } else {
  
         return false;
       }
     }

◆ getHeader()

const Head& JSUPPORT::JMultipleFileScanner< Head >::getHeader ( )

inline

Get Monte Carlo Header.

Returns: header

Definition at line 393 of file JMonteCarloFileSupportkit.hh.

     {
       const Head* p = NULL;
  
       if (!this->hasNext() || (p = this->next()) == NULL) {
         throw JNullPointerException("JMultipleFileScanner<Head>::getHeader(): Missing Header.");
       }
  
       rewind();
  
       return *p;
     }

◆ getFilename()

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 312 of file JMultipleFileScanner.hh.

     {
       return this->at(index);
     }

◆ getCounter()

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

inlineinherited

Get counter.

Returns: counter

Definition at line 323 of file JMultipleFileScanner.hh.

     {
       return counter;
     }

◆ hasNext() [1/2]

virtual bool JSUPPORT::JMultipleFileScanner< T >::hasNext ( )

inlinevirtualinherited

Check availability of next element.

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

Implements JLANG::JObjectIterator< T >.

Definition at line 350 of file JMultipleFileScanner.hh.

     {
       if (is_valid()) {
  
         if (counter < getUpperLimit() && index != this->size()) {
  
           // first time around
  
           if (!scanner.is_open()) {
             scanner.open(getFilename().c_str());
           }
           
           if (counter < getLowerLimit()) {
             counter += scanner.skip(getLowerLimit() - counter);
           }     
  
           if (!scanner.hasNext()) {
             
             scanner.close();
             
             ++index;
             
             return hasNext();
           }
  
           return true;
  
         } else {
  
           // last time around
  
           if (scanner.is_open()) {
             scanner.close();
           }
  
           scanner.reset();
         }
       }
  
       return false;
     }

◆ next() [1/2]

virtual const pointer_type& JSUPPORT::JMultipleFileScanner< T >::next ( )

inlinevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 398 of file JMultipleFileScanner.hh.

     {
       ++counter;
  
       return scanner.next();
     }

◆ skip() [1/2]

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

inlinevirtualinherited

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 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;
     }

◆ hasNext() [2/2]

template<class T>

virtual bool JLANG::JAbstractObjectIterator< T >::hasNext ( )

inlinevirtualinherited

Check availability of next element.

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

Implements JLANG::JObjectIterator< T >.

Definition at line 56 of file JAbstractObjectIterator.hh.

     {
       if (!has_next) {
         has_next = this->setObject(object);
       }
  
       return has_next;
     }

◆ next() [2/2]

template<class T>

virtual const pointer_type& JLANG::JAbstractObjectIterator< T >::next ( )

inlinevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

     {
       if (has_next)
         ps.reset(&this->object);
       else
         ps.reset(NULL);
  
       has_next = false;
       
       return ps;
     }