JLANG::JPipe< T > Class Template Reference

Auxiliary class for object iteration via pipe, i.e. operator: More...

#include <JPipe.hh>

Inheritance diagram for JLANG::JPipe< T >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JPipe (JObjectIterator< T > &input, const JValve< T > &valve, const JObjectSelector< T > &selector, const JRegulator &regulator)
	Constructor.
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
JObjectIterator< T > &	in
const JValve< T > &	valve
const JObjectSelector< T > &	selector
const JRegulator &	regulator

Private Attributes
pointer_type	ps
pointer_type	p

Detailed Description

template<class T>
class JLANG::JPipe< T >

Auxiliary class for object iteration via pipe, i.e. operator:

     .. | ..

A pipe consists of an object iterator, a valve, an object selector and a common regulator.
The objects are first passed through a valve which can be opened and closed.
The object selector can be used to filter specific objects/values.
Finally, the regulator can be used to control the throughput.

This class implements the JLANG::JObjectIterator interface.

Definition at line 37 of file JPipe.hh.

Member Typedef Documentation

pointer_type

template<class T >

JObjectIterator<T>::pointer_type JLANG::JPipe< T >::pointer_type

Definition at line 42 of file JPipe.hh.

Constructor & Destructor Documentation

JPipe()

template<class T >

JLANG::JPipe< T >::JPipe ( JObjectIterator< T > & input, const JValve< T > & valve, const JObjectSelector< T > & selector, const JRegulator & regulator )

inline

Constructor.

Parameters

input	object iterator
valve	valve
selector	object selector
regulator	regulator

Definition at line 52 of file JPipe.hh.

                                               :
      in       (input),
      valve    (valve),
      selector (selector),
      regulator(regulator)
    {}

Member Function Documentation

hasNext()

template<class T >

virtual bool JLANG::JPipe< 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 68 of file JPipe.hh.

    {
      if (!p.is_valid()) {
      
        if (valve.is_open()) {
        
          while (in.hasNext()) {
 
            p = in.next();
            
            if (selector.accept(*p)) {
              
              if (regulator.accept()) {
                return true;
              }
            }
          }
        }
 
        p = NULL; // invalid pointer for next round
        
        return false;
        
      } else {
 
        return true;
      }
    }

next()

template<class T >

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

inlineoverridevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 103 of file JPipe.hh.

    {
      ps = p;
 
      p.reset();
 
      return ps;
    }

skip()

template<class T >

virtual skip_type JLANG::JPipe< 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 >.

Definition at line 119 of file JPipe.hh.

    {
      return in.skip(ns);
    }

Member Data Documentation

in

template<class T >

JObjectIterator<T>& JLANG::JPipe< T >::in

protected

Definition at line 126 of file JPipe.hh.

valve

template<class T >

const JValve<T>& JLANG::JPipe< T >::valve

protected

Definition at line 127 of file JPipe.hh.

selector

template<class T >

const JObjectSelector<T>& JLANG::JPipe< T >::selector

protected

Definition at line 128 of file JPipe.hh.

regulator

template<class T >

const JRegulator& JLANG::JPipe< T >::regulator

protected

Definition at line 129 of file JPipe.hh.

ps

template<class T >

pointer_type JLANG::JPipe< T >::ps

private

Definition at line 132 of file JPipe.hh.

p

template<class T >

pointer_type JLANG::JPipe< T >::p

private

Definition at line 133 of file JPipe.hh.

---

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

• JPipe.hh