Abstract interface for object reading with rewinding. More...

#include <JAbstractObjectReader.hh>

Inheritance diagram for JLANG::JAbstractRewindableObjectReader< T >:

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

typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
virtual JRewindableObjectIterator< T > *	getHelper () const override=0
	Get helper. More...

virtual void	rewind () override
	Rewind. 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...

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...

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
struct JLANG::JAbstractRewindableObjectReader< T >

Abstract interface for object reading with rewinding.

This class implements the JRewindableObjectIterator interface by transferring the interface methods to a helper object via a single interface method getHelper().

Definition at line 89 of file JAbstractObjectReader.hh.

Member Typedef Documentation

◆ pointer_type [1/2]

template<class T >

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

inherited

Type definition of pointer_type.

Definition at line 58 of file JObjectIterator.hh.

◆ pointer_type [2/2]

template<class T >

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

inherited

Definition at line 27 of file JAbstractObjectReader.hh.

Member Function Documentation

◆ getHelper()

template<class T >

virtual JRewindableObjectIterator<T>* JLANG::JAbstractRewindableObjectReader< T >::getHelper ( ) const

overridepure virtual

Get helper.

Returns: pointer to helper

Implements JLANG::JAbstractObjectReader< T >.

Implemented in JLANG::JRewindableObjectReader< T >, and JLANG::JRewindableObjectReader< const T >.

◆ rewind()

template<class T >

virtual void JLANG::JAbstractRewindableObjectReader< T >::rewind ( )

inlineoverridevirtual

Rewind.

Implements JLANG::JRewindable< T >.

Reimplemented in JLANG::JSTDObjectReader< JTypeList< JHead_t, JTail_t > >.

Definition at line 104 of file JAbstractObjectReader.hh.

     {
       if (this->getHelper() != NULL) {
         this->getHelper()->rewind();
       }
     }

◆ hasNext() [1/2]

template<class T >

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

pure virtualinherited

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() [1/2]

template<class T >

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

pure virtualinherited

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() [1/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;
     }

◆ hasNext() [2/2]

template<class T >

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

     {
       return (this->getHelper() != NULL && this->getHelper()->hasNext());
     }

◆ next() [2/2]

template<class T >

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

inlineoverridevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 54 of file JAbstractObjectReader.hh.

     {
       if (this->getHelper() != NULL)
         return this->getHelper()->next();
       else
         return ps;
     }

◆ skip() [2/2]

template<class T >

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

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 69 of file JAbstractObjectReader.hh.

     {
       if (this->getHelper() != NULL)
         return this->getHelper()->skip(ns);
       else
         return 0;
     } 

Member Data Documentation

◆ ps

template<class T >

pointer_type JLANG::JAbstractObjectReader< T >::ps

privateinherited

Definition at line 78 of file JAbstractObjectReader.hh.

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

JAbstractObjectReader.hh

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<class T> struct JLANG::JAbstractRewindableObjectReader< T >

Member Typedef Documentation

◆ pointer_type [1/2]

◆ pointer_type [2/2]

Member Function Documentation

◆ getHelper()

◆ rewind()

◆ hasNext() [1/2]

◆ next() [1/2]

◆ skip() [1/2]

◆ hasNext() [2/2]

◆ next() [2/2]

◆ skip() [2/2]

Member Data Documentation

◆ ps

template<class T>
struct JLANG::JAbstractRewindableObjectReader< T >