JSUPPORT::JParallelFileScanner< T, JFileScanner_t > Class Template Reference

General purpose class for parallel reading of objects from a single file or multiple files. More...

#include <JParallelFileScanner.hh>

Inheritance diagram for JSUPPORT::JParallelFileScanner< T, JFileScanner_t >:

Public Types
typedef JFileScanner_t< JNullType >::input_type	input_type
typedef JMultiPointer< T >	multi_pointer_type
typedef JRewindableObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JParallelFileScanner ()
	Default constructor. More...
	JParallelFileScanner (const input_type &input)
	Constructor. More...
	JParallelFileScanner (const input_type &input, const JLimit &limit)
	Constructor. More...
virtual const multi_pointer_type &	next () override
	Get next element. 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 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

Private Attributes
multi_pointer_type	ps

Detailed Description

template<class T, template< class > class JFileScanner_t = JSingleFileScanner>
class JSUPPORT::JParallelFileScanner< T, JFileScanner_t >

General purpose class for parallel reading of objects from a single file or multiple files.

Definition at line 33 of file JParallelFileScanner.hh.

Member Typedef Documentation

input_type

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

typedef JFileScanner_t<JNullType>::input_type JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::input_type

Definition at line 38 of file JParallelFileScanner.hh.

multi_pointer_type

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

typedef JMultiPointer<T> JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::multi_pointer_type

Definition at line 39 of file JParallelFileScanner.hh.

pointer_type

template<class T >

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

inherited

Definition at line 176 of file JSingleFileScanner.hh.

Constructor & Destructor Documentation

JParallelFileScanner() [1/3]

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::JParallelFileScanner ( )

inline

Default constructor.

Definition at line 45 of file JParallelFileScanner.hh.

    {}

JParallelFileScanner() [2/3]

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::JParallelFileScanner ( const input_type &  input )

inline

Constructor.

Parameters

input

input

Definition at line 54 of file JParallelFileScanner.hh.

    {
      this->configure(input, JLimit());
    }

JParallelFileScanner() [3/3]

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::JParallelFileScanner ( const input_type &  input, const JLimit &  limit  )

inline

Constructor.

Parameters

input	input
limit	limit

Definition at line 66 of file JParallelFileScanner.hh.

    {
      this->configure(input, limit);
    }

Member Function Documentation

next()

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

virtual const multi_pointer_type& JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::next ( )

inlineoverridevirtual

Get next element.

Returns

multi-pointer to element

Reimplemented from JSUPPORT::JSingleFileScanner< T >.

Reimplemented in JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >, and JSUPPORT::JParallelFileScanner< JTypeList< JHead_t, JTail_t >, JFileScanner_t >.

Definition at line 77 of file JParallelFileScanner.hh.

    {
      ps.set(JFileScanner_t<T>::next());
      
      return ps;
    }

getCounter()

template<class T >

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

inlineinherited

Get counter.

Returns

counter

Definition at line 231 of file JSingleFileScanner.hh.

    {
      return counter;
    }

rewind()

template<class T >

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

inlineoverridevirtualinherited

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 ( )

inlineoverridevirtualinherited

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

skip() [1/2]

template<class T >

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

inlineoverridevirtualinherited

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

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

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::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

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

Member Data Documentation

ps

template<class T , template< class > class JFileScanner_t = JSingleFileScanner>

multi_pointer_type JSUPPORT::JParallelFileScanner< T, JFileScanner_t >::ps

private

Definition at line 85 of file JParallelFileScanner.hh.

scanner

template<class T >

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

protectedinherited

Definition at line 328 of file JSingleFileScanner.hh.

counter

template<class T >

counter_type JSUPPORT::JSingleFileScanner< T >::counter

protectedinherited

Definition at line 329 of file JSingleFileScanner.hh.

---

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

• JParallelFileScanner.hh