JLANG::JAbstractObjectIterator< T > Class Template Reference

Abstract object iterator. More...

#include <JAbstractObjectIterator.hh>

Inheritance diagram for JLANG::JAbstractObjectIterator< T >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
virtual bool	setObject (T &object)=0
	Set object.
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)
	Skip items.

Protected Member Functions
	JAbstractObjectIterator ()
	Default constructor.

Protected Attributes
T	object
	object
bool	has_next
	status

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
class JLANG::JAbstractObjectIterator< T >

Abstract object iterator.

This class implements the JObjectIterator interface via a single interface method setObject().
An internal object is used for which the default constructor should exist.

Definition at line 23 of file JAbstractObjectIterator.hh.

Member Typedef Documentation

pointer_type

template<class T >

JObjectIterator<T>::pointer_type JLANG::JAbstractObjectIterator< T >::pointer_type

Definition at line 39 of file JAbstractObjectIterator.hh.

Constructor & Destructor Documentation

JAbstractObjectIterator()

template<class T >

JLANG::JAbstractObjectIterator< T >::JAbstractObjectIterator ( )

inlineprotected

Default constructor.

Definition at line 30 of file JAbstractObjectIterator.hh.

                              :
      has_next(false)
    {}

Member Function Documentation

setObject()

template<class T >

virtual bool JLANG::JAbstractObjectIterator< T >::setObject ( T & object )

pure virtual

Set object.

Parameters

object

reference to object to be set

Returns

true if set; else false

Implemented in JDATABASE::JDatabaseObjectIterator< T >, JIO::JReaderObjectIterator< T >, JLANG::JStreamObjectIterator< T >, JNET::JControlHostObjectIterator< T >, JNET::JLigierObjectIterator< T >, and JSUPPORT::JDAQFileReader< T, true >.

hasNext()

template<class T >

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

    {
      if (!has_next) {
        has_next = this->setObject(object);
      }
 
      return has_next;
    }

next()

template<class T >

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

inlineoverridevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

    {
      if (has_next)
        ps.reset(&this->object);
      else
        ps.reset(NULL);
 
      has_next = false;
      
      return ps;
    }

skip()

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::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< Evt >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< Evt >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JTypeList< JHead_t, JTail_t > >, and JSUPPORT::JSingleFileScanner<>.

Definition at line 90 of file JObjectIterator.hh.

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

Member Data Documentation

object

template<class T >

T JLANG::JAbstractObjectIterator< T >::object

protected

object

Definition at line 34 of file JAbstractObjectIterator.hh.

has_next

template<class T >

bool JLANG::JAbstractObjectIterator< T >::has_next

protected

status

Definition at line 35 of file JAbstractObjectIterator.hh.

ps

template<class T >

pointer_type JLANG::JAbstractObjectIterator< T >::ps

private

Definition at line 84 of file JAbstractObjectIterator.hh.

---

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

• JAbstractObjectIterator.hh