Jpp  master_rocky-40-g5f0272dcd
the software that should make you happy
Public Types | Public Member Functions | Private Attributes | List of all members
JLANG::JAbstractRewindableObjectReader< T > Struct Template Referenceabstract

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

#include <JAbstractObjectReader.hh>

Inheritance diagram for JLANG::JAbstractRewindableObjectReader< T >:
JLANG::JRewindableObjectIterator< T > JLANG::JAbstractObjectReader< T > JLANG::JObjectIterator< T > JLANG::JRewindable< T > JLANG::JObjectIterator< T > JLANG::JRewindableObjectReader< const T > JLANG::JRewindableObjectReader< T > JLANG::JSTDObjectReader< const T > JLANG::JSTDObjectReader< const event_type > JLANG::JSTDObjectReader< JTail_t > JLANG::JSTDObjectReader< JHead_t > JLANG::JSTDObjectReader< T > JLANG::JSTDObjectReader< JTypeList< JHead_t, JTail_t > > JLANG::JSTDObjectReader< JTypeList< JHead_t, JNullType > > JLANG::JSTDObjectReader< JTypeList< JHead_t, JTail_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_typenext ()=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_typenext () 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.

105  {
106  if (this->getHelper() != NULL) {
107  this->getHelper()->rewind();
108  }
109  }
virtual JRewindableObjectIterator< T > * getHelper() const override=0
Get helper.

◆ hasNext() [1/2]

template<class T >
virtual bool JLANG::JObjectIterator< T >::hasNext ( )
pure virtualinherited

◆ next() [1/2]

template<class T >
virtual const pointer_type& JLANG::JObjectIterator< T >::next ( )
pure virtualinherited

◆ skip() [1/2]

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

Skip items.

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

91  {
92  skip_type i = 0;
93 
94  for ( ; i != ns && hasNext(); ++i) {
95  next();
96  }
97 
98  return i;
99  }
virtual const pointer_type & next()=0
Get next element.
virtual bool hasNext()=0
Check availability of next element.
unsigned int skip_type
Type definition for number of objects to skip.
std::vector< size_t > ns

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

44  {
45  return (this->getHelper() != NULL && this->getHelper()->hasNext());
46  }
virtual JObjectIterator< T > * getHelper() const =0
Get helper.
virtual bool hasNext() override
Check availability of next element.

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

55  {
56  if (this->getHelper() != NULL)
57  return this->getHelper()->next();
58  else
59  return ps;
60  }

◆ skip() [2/2]

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

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 69 of file JAbstractObjectReader.hh.

70  {
71  if (this->getHelper() != NULL)
72  return this->getHelper()->skip(ns);
73  else
74  return 0;
75  }

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: