JSUPPORT::JSingleFileScanner< T > Class Template Reference

Object reading from a list of files. More...

#include <JSingleFileScanner.hh>

Inheritance diagram for JSUPPORT::JSingleFileScanner< T >:

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

Public Member Functions
	JSingleFileScanner ()
	Default constructor. More...
template<class JTypelist_t >
	JSingleFileScanner (const JSingleFileScanner< JTypelist_t > &input)
	Copy constructor. More...
	JSingleFileScanner (const input_type &file_name)
	Constructor. More...
	JSingleFileScanner (const input_type &file_name, const JLimit &limit)
	Constructor. 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
counter_type	counter

Detailed Description

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

Object reading from a list of files.

Object reading from a single file name.

This class implements the JLANG::JRewindableObjectIterator interface.

Definition at line 75 of file JSingleFileScanner.hh.

Member Typedef Documentation

template<class T = JNullType>

typedef JSingleFileScanner ::input_type JSUPPORT::JSingleFileScanner< T >::input_type

Definition at line 164 of file JSingleFileScanner.hh.

template<class T = JNullType>

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

Definition at line 165 of file JSingleFileScanner.hh.

Constructor & Destructor Documentation

template<class T = JNullType>

JSUPPORT::JSingleFileScanner< T >::JSingleFileScanner ( )

inline

Default constructor.

Definition at line 170 of file JSingleFileScanner.hh.

                         :
      counter(0)
    {}

template<class T = JNullType>

template<class JTypelist_t >

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

inline

Copy constructor.

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

Parameters

input

input

Definition at line 183 of file JSingleFileScanner.hh.

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

template<class T = JNullType>

JSUPPORT::JSingleFileScanner< T >::JSingleFileScanner ( const input_type &  file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 195 of file JSingleFileScanner.hh.

                                                    :
      counter(0)
    {
      this->configure(file_name, JLimit());
    }

template<class T = JNullType>

JSUPPORT::JSingleFileScanner< T >::JSingleFileScanner ( const input_type &  file_name, const JLimit &  limit  )

inline

Constructor.

Parameters

file_name	file name
limit	limit

Definition at line 208 of file JSingleFileScanner.hh.

                                                                         :
      counter(0)
    {
      this->configure(file_name, limit);
    }

Member Function Documentation

template<class T = JNullType>

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

inline

Get counter.

Returns

counter

Definition at line 220 of file JSingleFileScanner.hh.

    {
      return counter;
    }

template<class T = JNullType>

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

inlineoverridevirtual

Rewind.

Implements JLANG::JRewindable< T >.

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

Definition at line 229 of file JSingleFileScanner.hh.

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

      counter = 0;

      scanner.reset();
    }

template<class T = JNullType>

virtual bool JSUPPORT::JSingleFileScanner< 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 246 of file JSingleFileScanner.hh.

    {
      if (is_valid()) {

        if (counter < getUpperLimit()) {

          // first time around

          if (!scanner.is_open()) {
            scanner.open(this->getFilename().c_str());
          }

          if (counter < getLowerLimit()) {
            counter += scanner.skip(getLowerLimit() - counter);
          }
          
          if (!scanner.hasNext()) {

            scanner.close();

            return false;
          }
          
          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::JSingleFileScanner< T >::next ( )

inlineoverridevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 292 of file JSingleFileScanner.hh.

    {
      ++counter;

      return scanner.next();
    }

template<class T = JNullType>

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

inlineoverridevirtual

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

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

Definition at line 306 of file JSingleFileScanner.hh.

    {
      const skip_type previous = counter;

      counter += scanner.skip(ns);

      return counter - previous;
    }

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::JSingleFileScanner< T >::scanner

protected

Definition at line 317 of file JSingleFileScanner.hh.

template<class T = JNullType>

counter_type JSUPPORT::JSingleFileScanner< T >::counter

protected

Definition at line 318 of file JSingleFileScanner.hh.

---

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

• JSingleFileScanner.hh