JSUPPORT::JMultipleFileScanner< T > Class Template Reference

General purpose class for object reading from a list of file names. More...

#include <JMultipleFileScanner.hh>

Inheritance diagram for JSUPPORT::JMultipleFileScanner< T >:

Public Types
typedef JMultipleFileScanner::input_type	input_type
typedef JRewindableObjectIterator< T > ::pointer_type	pointer_type

Public Member Functions
	JMultipleFileScanner ()
	Default constructor. More...
template<class JTypelist_t >
	JMultipleFileScanner (const JMultipleFileScanner< JTypelist_t > &input)
	Copy constructor. More...
	JMultipleFileScanner (const input_type &file_list)
	Constructor. More...
	JMultipleFileScanner (const input_type &file_list, const JLimit &limit)
	Constructor. 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 bool	hasNext () override
	Check availability of next element. More...
virtual const pointer_type &	next () override
	Get next element. 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
JFileScanner< T >	scanner
unsigned int	index
counter_type	counter

Detailed Description

template<class T = JNullType>
class JSUPPORT::JMultipleFileScanner< T >

General purpose class for object reading from a list of file names.

Implementation of object reading for single data type from a list of file names.

This class extends the JMultipleFileScanner<JNullType> class and implements the JLANG::JRewindableObjectIterator interface.
When the method hasNext() is called, the next file in the list is opened when the previous file is exhausted.

Definition at line 199 of file JMultipleFileScanner.hh.

Member Typedef Documentation

template<class T = JNullType>

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

Definition at line 295 of file JMultipleFileScanner.hh.

template<class T = JNullType>

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

Definition at line 296 of file JMultipleFileScanner.hh.

Constructor & Destructor Documentation

template<class T = JNullType>

JSUPPORT::JMultipleFileScanner< T >::JMultipleFileScanner ( )

inline

Default constructor.

Definition at line 301 of file JMultipleFileScanner.hh.

                           :
      index  (0),
      counter(0)
    {}

template<class T = JNullType>

template<class JTypelist_t >

JSUPPORT::JMultipleFileScanner< T >::JMultipleFileScanner ( const JMultipleFileScanner< JTypelist_t > &  input )

inline

Copy constructor.

Note that the counter limit is not copied and the index and counter are set to zero.

Parameters

input

input

Definition at line 315 of file JMultipleFileScanner.hh.

                                                                         :
      index  (0),
      counter(0)
    {
      this->configure(input.getFilelist(), JLimit());
    }

template<class T = JNullType>

JSUPPORT::JMultipleFileScanner< T >::JMultipleFileScanner ( const input_type &  file_list )

inline

Constructor.

Parameters

file_list

list of file names

Definition at line 328 of file JMultipleFileScanner.hh.

                                                      :
      index  (0),
      counter(0)
    {
      configure(file_list, JLimit());
    }

template<class T = JNullType>

JSUPPORT::JMultipleFileScanner< T >::JMultipleFileScanner ( const input_type &  file_list, const JLimit &  limit  )

inline

Constructor.

Parameters

file_list	list of file names
limit	limit

Definition at line 342 of file JMultipleFileScanner.hh.

                                                                           :
      index  (0),
      counter(0)
    {
      configure(file_list, limit);
    }

Member Function Documentation

template<class T = JNullType>

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

inline

Get current file name.

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

Returns

file name

Definition at line 357 of file JMultipleFileScanner.hh.

    {
      return this->at(index);
    }

template<class T = JNullType>

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

inline

Get counter.

Returns

counter

Definition at line 368 of file JMultipleFileScanner.hh.

    {
      return counter;
    }

template<class T = JNullType>

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

inlineoverridevirtual

Rewind.

Implements JLANG::JRewindable< T >.

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

Definition at line 377 of file JMultipleFileScanner.hh.

    {
      if (scanner.is_open()) {
        scanner.close();
      }

      index   = 0;
      counter = 0;

      scanner.reset();
    }

template<class T = JNullType>

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

inlineoverridevirtual

Check availability of next element.

Returns

true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 395 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;
    }

template<class T = JNullType>

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

inlineoverridevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 443 of file JMultipleFileScanner.hh.

    {
      ++counter;

      return scanner.next();
    }

template<class T = JNullType>

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

inlineoverridevirtual

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

    {
      skip_type i = 0;

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

      counter += i;

      return i;
    }

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

Definition at line 90 of file JObjectIterator.hh.

    {
      skip_type i = 0;

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

      return i;
    }

Member Data Documentation

template<class T = JNullType>

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

protected

Definition at line 472 of file JMultipleFileScanner.hh.

template<class T = JNullType>

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

protected

Definition at line 473 of file JMultipleFileScanner.hh.

template<class T = JNullType>

counter_type JSUPPORT::JMultipleFileScanner< T >::counter

protected

Definition at line 474 of file JMultipleFileScanner.hh.

---

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

• JMultipleFileScanner.hh