JLANG::JObjectReader< T > Struct Template Reference

Auxiliary class for object reading. More...

#include <JObjectReader.hh>

Inheritance diagram for JLANG::JObjectReader< T >:

Public Types
typedef std::shared_ptr< JObjectIterator< T > >	helper_type
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JObjectReader ()
	Default constructor.
virtual JObjectIterator< T > *	getHelper () const override
	Get helper.
virtual bool	hasNext ()=0
	Check availability of next element.
virtual const pointer_type &	next ()=0
	Get next element.
virtual skip_type	skip (const skip_type ns)
	Skip items.
bool	is_valid () const
	Check validity of helper.
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.

Private Attributes
pointer_type	ps

Detailed Description

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

Auxiliary class for object reading.

This class implements the JAbstractObjectReader interface.

Definition at line 24 of file JObjectReader.hh.

Member Typedef Documentation

helper_type

template<class T >

std::shared_ptr< JObjectIterator<T> > JLANG::JObjectReader< T >::helper_type

Definition at line 30 of file JObjectReader.hh.

pointer_type

template<class T >

JObjectIterator<T>::pointer_type JLANG::JObjectReader< T >::pointer_type

Definition at line 31 of file JObjectReader.hh.

Constructor & Destructor Documentation

JObjectReader()

template<class T >

JLANG::JObjectReader< T >::JObjectReader ( )

inline

Default constructor.

Definition at line 36 of file JObjectReader.hh.

    {}

Member Function Documentation

getHelper()

template<class T >

virtual JObjectIterator< T > * JLANG::JObjectReader< T >::getHelper ( ) const

inlineoverridevirtual

Get helper.

Returns

helper

Implements JLANG::JAbstractObjectReader< T >.

Definition at line 45 of file JObjectReader.hh.

    {
      return this->get();
    }

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 JLANG::JAbstractObjectIterator< T >, JLANG::JAbstractObjectIterator< Head >, JLANG::JAbstractObjectIterator< JHead_t >, JLANG::JAbstractObjectIterator< JTail_t >, JLANG::JAbstractObjectIterator< JTriggerParameters >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JNullIterator< T >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< JDAQSummaryslice, JRandomSampler >, JLANG::JObjectSampler< T, JSampler >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JLineAttributes, JROOT::JMarkerAttributes, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner<>, and JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_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 JLANG::JAbstractObjectIterator< T >, JLANG::JAbstractObjectIterator< Head >, JLANG::JAbstractObjectIterator< JHead_t >, JLANG::JAbstractObjectIterator< JTail_t >, JLANG::JAbstractObjectIterator< JTriggerParameters >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JNullIterator< T >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< JDAQSummaryslice, JRandomSampler >, JLANG::JObjectSampler< T, JSampler >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JLineAttributes, JROOT::JMarkerAttributes, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JParallelFileScanner< T, JFileScanner_t >, JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType >, JMultipleFileScanner >, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner<>, and JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_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::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, 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< 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;
    }

is_valid()

template<class T >

bool JLANG::JAbstractObjectReader< T >::is_valid ( ) const

inlineinherited

Check validity of helper.

Returns

true if helper not null; else false

Definition at line 35 of file JAbstractObjectReader.hh.

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

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 54 of file JAbstractObjectReader.hh.

    {
      return (this->is_valid() && 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 65 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        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 80 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        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 89 of file JAbstractObjectReader.hh.

---

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

• JObjectReader.hh