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.
template<class JTypelist_t >
	JSingleFileScanner (const JSingleFileScanner< JTypelist_t > &input)
	Copy constructor.
	JSingleFileScanner (const input_type &file_name)
	Constructor.
	JSingleFileScanner (const input_type &file_name, const JLimit &limit)
	Constructor.
counter_type	getCounter () const
	Get counter.
virtual void	rewind () override
	Rewind.
virtual bool	hasNext () override
	Check availability of next element.
virtual const pointer_type &	next () override
	Get next element.
virtual skip_type	skip (const skip_type ns) override
	Skip items.

Protected Attributes
JFileScanner< T >	scanner
counter_type	counter

Detailed Description

template<class T>
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 169 of file JSingleFileScanner.hh.

Member Typedef Documentation

input_type

template<class T >

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

Definition at line 175 of file JSingleFileScanner.hh.

pointer_type

template<class T >

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

Definition at line 176 of file JSingleFileScanner.hh.

Constructor & Destructor Documentation

JSingleFileScanner() [1/4]

template<class T >

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

inline

Default constructor.

Definition at line 181 of file JSingleFileScanner.hh.

                         :
      counter(0)
    {}

JSingleFileScanner() [2/4]

template<class T >

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 194 of file JSingleFileScanner.hh.

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

JSingleFileScanner() [3/4]

template<class T >

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

inline

Constructor.

Parameters

file_name

file name

Definition at line 206 of file JSingleFileScanner.hh.

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

JSingleFileScanner() [4/4]

template<class T >

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

inline

Constructor.

Parameters

file_name	file name
limit	limit

Definition at line 219 of file JSingleFileScanner.hh.

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

Member Function Documentation

getCounter()

template<class T >

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

inline

Get counter.

Returns

counter

Definition at line 231 of file JSingleFileScanner.hh.

    {
      return counter;
    }

rewind()

template<class T >

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

inlineoverridevirtual

Rewind.

Implements JLANG::JRewindable< T >.

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

Definition at line 240 of file JSingleFileScanner.hh.

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

hasNext()

template<class T >

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

next()

template<class T >

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

inlineoverridevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Reimplemented in JSUPPORT::JParallelFileScanner< T, JFileScanner_t >.

Definition at line 303 of file JSingleFileScanner.hh.

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

skip()

template<class T >

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 from JLANG::JObjectIterator< T >.

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

Definition at line 317 of file JSingleFileScanner.hh.

    {
      const skip_type previous = counter;
 
      counter += scanner.skip(ns);
 
      return counter - previous;
    }

Member Data Documentation

scanner

template<class T >

JFileScanner<T> JSUPPORT::JSingleFileScanner< T >::scanner

protected

Definition at line 328 of file JSingleFileScanner.hh.

counter

template<class T >

counter_type JSUPPORT::JSingleFileScanner< T >::counter

protected

Definition at line 329 of file JSingleFileScanner.hh.

---

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

• JSingleFileScanner.hh