JLANG::JObjectIterator< T > Class Template Reference

Interface of object iteration for a single data type. More...

#include <JObjectIterator.hh>

Inheritance diagram for JLANG::JObjectIterator< T >:

Public Types
typedef JPointer< T >	pointer_type
	Type definition of pointer_type. More...

Public Member Functions
virtual	~JObjectIterator ()
	Virtual destructor. More...
virtual bool	hasNext ()=0
	Check availability of next element. More...
virtual const pointer_type &	next ()=0
	Get next element. More...
virtual skip_type	skip (const skip_type ns)
	Skip items. More...

Protected Member Functions
	JObjectIterator ()
	Default constructor. More...

Friends
JObjectIterator< T > &	operator>> (JObjectIterator< T > &in, JObjectOutput< T > &out)
	Copy to object output. More...
void	operator| (JObjectIterator< T > &left, JObjectOutput< T > &right)
	Pipe terminator. More...
JMultiPipe< T, 0 > &	operator| (JObjectIterator< T > &left, const JValve< T > &right)
	Pipe operator. More...
JMultiPipe< T, 0 > &	operator| (JObjectIterator< T > &left, const JObjectSelector< T > &right)
	Pipe operator. More...
JMultiPipe< T, 0 > &	operator| (JObjectIterator< T > &left, const JRegulator &right)
	Pipe operator. More...
template<class JBase_t >
JObjectMultiplexer< T, JBase_t > &	operator| (JObjectIterator< T > &left, const JType< JBase_t > &right)
	Pipe operator. More...

Detailed Description

template<class T>
class JLANG::JObjectIterator< T >

Interface of object iteration for a single data type.

Definition at line 45 of file JObjectIterator.hh.

Member Typedef Documentation

pointer_type

template<class T >

typedef JPointer<T> JLANG::JObjectIterator< T >::pointer_type

Type definition of pointer_type.

Definition at line 58 of file JObjectIterator.hh.

Constructor & Destructor Documentation

JObjectIterator()

template<class T >

JLANG::JObjectIterator< T >::JObjectIterator ( )

inlineprotected

Default constructor.

Definition at line 50 of file JObjectIterator.hh.

    {}

~JObjectIterator()

template<class T >

virtual JLANG::JObjectIterator< T >::~JObjectIterator ( )

inlinevirtual

Virtual destructor.

Definition at line 64 of file JObjectIterator.hh.

    {}

Member Function Documentation

hasNext()

template<class T >

virtual bool JLANG::JObjectIterator< T >::hasNext ( )

pure virtual

Check availability of next element.

Returns

true if the iteration has more elements; else false

Implemented in JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner<>, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner< Evt >, JROOT::JTreeReaderObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JMarkerAttributes, JROOT::JLineAttributes, JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< T, JSampler >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectIterator< T >, and JLANG::JNullIterator< T >.

next()

template<class T >

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

pure virtual

Get next element.

Returns

pointer to element

Implemented in JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner<>, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JParallelFileScanner< T, JFileScanner_t >, JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType >, JMultipleFileScanner >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner< Evt >, JROOT::JTreeReaderObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JMarkerAttributes, JROOT::JLineAttributes, JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< T, JSampler >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectIterator< T >, and JLANG::JNullIterator< T >.

skip()

template<class T >

virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type  ns )

inlinevirtual

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

Friends And Related Function Documentation

operator>>

template<class T >

JObjectIterator<T>& operator>> ( JObjectIterator< T > &  in, JObjectOutput< T > &  out  )

friend

Copy to object output.

Parameters

in	object iterator
out	object output

Returns

object iterator

Definition at line 109 of file JObjectIterator.hh.

    {
      while (in.hasNext()) {
 
        const T* p = in.next();
 
        if (p != NULL)
          out.put(*p);
        else
          break; 
      }
 
      return in;
    }

operator| [1/5]

template<class T >

void operator| ( JObjectIterator< T > &  left, JObjectOutput< T > &  right  )

friend

Pipe terminator.

Parameters

left	object iterator
right	object output

Definition at line 132 of file JObjectIterator.hh.

    {
      left >> right;
    }

operator| [2/5]

template<class T >

JMultiPipe<T,0>& operator| ( JObjectIterator< T > &  left, const JValve< T > &  right  )

friend

Pipe operator.

Parameters

left	object iterator
right	valve

Returns

pipe object

Definition at line 145 of file JObjectIterator.hh.

    {
      JMultiPipe<T,0>::pipe.reset(new JMultiPipe<T,0>(left, right));
 
      return *JMultiPipe<T,0>::pipe;
    }

operator| [3/5]

template<class T >

JMultiPipe<T,0>& operator| ( JObjectIterator< T > &  left, const JObjectSelector< T > &  right  )

friend

Pipe operator.

Parameters

left	object iterator
right	object selector

Returns

pipe object

Definition at line 160 of file JObjectIterator.hh.

    {
      JMultiPipe<T,0>::pipe.reset(new JMultiPipe<T,0>(left, right));
 
      return *JMultiPipe<T,0>::pipe;
    }

operator| [4/5]

template<class T >

JMultiPipe<T,0>& operator| ( JObjectIterator< T > &  left, const JRegulator &  right  )

friend

Pipe operator.

Parameters

left	object iterator
right	regulator

Returns

pipe object

Definition at line 175 of file JObjectIterator.hh.

    {
      JMultiPipe<T,0>::pipe.reset(new JMultiPipe<T,0>(left, right));
 
      return *JMultiPipe<T,0>::pipe;
    }

operator| [5/5]

template<class T >

template<class JBase_t >

JObjectMultiplexer<T, JBase_t>& operator| ( JObjectIterator< T > &  left, const JType< JBase_t > &  right  )

friend

Pipe operator.

Parameters

left	object iterator
right	data type

Returns

object multiplexer

Definition at line 191 of file JObjectIterator.hh.

    {
      JObjectMultiplexer<T, JBase_t>::multiplexer.reset(new JObjectMultiplexer<T, JBase_t>(left));
 
      return *JObjectMultiplexer<T, JBase_t>::multiplexer;
    }

---

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

• JObjectIterator.hh