JLANG::JObjectSampler< T, JSampler_t > Class Template Reference

Auxiliary class to sample objects from a rewindable object iterator. More...

#include <JObjectSampler.hh>

Inheritance diagram for JLANG::JObjectSampler< T, JSampler_t >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JObjectSampler (JRewindableObjectIterator< T > &input)
	Constructor. More...
	JObjectSampler (JRewindableObjectIterator< T > &input, const JSampler_t< T > &sampler)
	Constructor. More...
virtual bool	hasNext ()
	Check availability of next element. More...
virtual const pointer_type &	next ()
	Get next element. More...
const JSampler_t< T > &	getSampler () const
	Get sampler. More...
JSampler_t< T > &	getSampler ()
	Get sampler. More...
virtual skip_type	skip (const skip_type ns)
	Skip items. More...

Protected Attributes
JRewindableObjectIterator< T > &	in
JSampler_t< T >	sampler
JPointer< T >	ps
bool	has_next

Detailed Description

template<class T, template< class > class JSampler_t = JSampler>
class JLANG::JObjectSampler< T, JSampler_t >

Auxiliary class to sample objects from a rewindable object iterator.

Method hasNext normally returns true, unless

• there are no available objects; or
• given sampler rejects every object.

Note that the internal sampler is a copy of the specified sampler and not a reference thereof.

This class implements the JObjectIterator interface.

Definition at line 30 of file JObjectSampler.hh.

Member Typedef Documentation

pointer_type

template<class T, template< class > class JSampler_t = JSampler>

typedef JObjectIterator<T>::pointer_type JLANG::JObjectSampler< T, JSampler_t >::pointer_type

Definition at line 35 of file JObjectSampler.hh.

Constructor & Destructor Documentation

JObjectSampler() [1/2]

template<class T, template< class > class JSampler_t = JSampler>

JLANG::JObjectSampler< T, JSampler_t >::JObjectSampler ( JRewindableObjectIterator< T > &  input )

inline

Constructor.

Parameters

input

input

Definition at line 42 of file JObjectSampler.hh.

                                                        :
      in      (input),
      has_next(false)
    {}

JObjectSampler() [2/2]

template<class T, template< class > class JSampler_t = JSampler>

JLANG::JObjectSampler< T, JSampler_t >::JObjectSampler ( JRewindableObjectIterator< T > &  input, const JSampler_t< T > &  sampler  )

inline

Constructor.

Parameters

input	input
sampler	sampler

Definition at line 54 of file JObjectSampler.hh.

                                                          :
      in      (input),
      has_next(false)
    {
      this->sampler = sampler;
    }

Member Function Documentation

hasNext()

template<class T, template< class > class JSampler_t = JSampler>

virtual bool JLANG::JObjectSampler< T, JSampler_t >::hasNext ( )

inlinevirtual

Check availability of next element.

Returns

true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 68 of file JObjectSampler.hh.

    {
      while (!has_next) {
 
        if (!in.hasNext()) {
          in.rewind();
        }
 
        if (in.hasNext()) {
 
          ps.set(in.next());
          
          skip_type ns = sampler(*ps);
 
          if (ns == 0) {
 
            has_next = true;
 
          } else {
 
            while ((ns -= in.skip(ns)) != 0) {
              in.rewind();
            }
          }
 
        } else {
 
          // nothing to sample
          
          break;
        }
      }
 
      return has_next;
    }

next()

template<class T, template< class > class JSampler_t = JSampler>

virtual const pointer_type& JLANG::JObjectSampler< T, JSampler_t >::next ( )

inlinevirtual

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 110 of file JObjectSampler.hh.

    {
      if (!has_next) {
        ps.reset(NULL);
      }
 
      has_next = false;
      
      return ps;
    }

getSampler() [1/2]

template<class T, template< class > class JSampler_t = JSampler>

const JSampler_t<T>& JLANG::JObjectSampler< T, JSampler_t >::getSampler ( ) const

inline

Get sampler.

Returns

sampler

Definition at line 127 of file JObjectSampler.hh.

    {
      return sampler;
    }

getSampler() [2/2]

template<class T, template< class > class JSampler_t = JSampler>

JSampler_t<T>& JLANG::JObjectSampler< T, JSampler_t >::getSampler ( )

inline

Get sampler.

Returns

sampler

Definition at line 138 of file JObjectSampler.hh.

    {
      return sampler;
    }

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::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JSTDObjectIterator< T >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, and JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 88 of file JObjectIterator.hh.

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

Member Data Documentation

in

template<class T, template< class > class JSampler_t = JSampler>

JRewindableObjectIterator<T>& JLANG::JObjectSampler< T, JSampler_t >::in

protected

Definition at line 144 of file JObjectSampler.hh.

sampler

template<class T, template< class > class JSampler_t = JSampler>

JSampler_t<T> JLANG::JObjectSampler< T, JSampler_t >::sampler

protected

Definition at line 145 of file JObjectSampler.hh.

ps

template<class T, template< class > class JSampler_t = JSampler>

JPointer<T> JLANG::JObjectSampler< T, JSampler_t >::ps

protected

Definition at line 146 of file JObjectSampler.hh.

has_next

template<class T, template< class > class JSampler_t = JSampler>

bool JLANG::JObjectSampler< T, JSampler_t >::has_next

protected

Definition at line 147 of file JObjectSampler.hh.

---

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

• JObjectSampler.hh