JSUPPORT::JRunByRun Struct Reference

Auxiliary class to select summary data (KM3NETDAQ::JDAQSummaryslice) from the specified raw data file(s). More...

#include <JRunByRun.hh>

Inheritance diagram for JSUPPORT::JRunByRun:

Public Types
typedef JRandomSampler < JDAQSummaryslice >	sampler_type
typedef JObjectIterator< T > ::pointer_type	pointer_type

Public Member Functions
	JRunByRun ()
	Default constructor. More...
bool	is_valid () const
	Check validity of run by run options. More...
const JMultipleFileScanner < JDAQSummaryslice > *const	operator-> () const
	Smart pointer operator. More...
JMultipleFileScanner < JDAQSummaryslice > *	operator-> ()
	Smart pointer operator. More...
virtual bool	hasNext () override
	Check availability of next element. More...
virtual const pointer_type &	next () override
	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...

Static Protected Member Functions
template<class T >
static JProperties	getProperties (T &object)
	Get properties of this class. More...

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

Friends
std::istream &	operator>> (std::istream &in, JRunByRun &object)
	Read run by run options from input. More...
std::ostream &	operator<< (std::ostream &out, const JRunByRun &object)
	Write run by run options to output. More...

Detailed Description

Auxiliary class to select summary data (KM3NETDAQ::JDAQSummaryslice) from the specified raw data file(s).

The use case of this class primarily is for the run-by-run mode of JTriggerEfficiency.cc.
The two parameters of the JSUPPORT::JRandomSampler class should then be set to sufficiently cover the contents of raw data file(s) and to minimise possible biases.
The values can also be tuned to reduce the overhead of accessing the data in the input file(s).

Definition at line 32 of file JRunByRun.hh.

Member Typedef Documentation

typedef JRandomSampler <JDAQSummaryslice > JSUPPORT::JMultipleFileSampler< JDAQSummaryslice , JRandomSampler >::sampler_type

inherited

Definition at line 60 of file JMultipleFileSampler.hh.

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

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

inherited

Definition at line 45 of file JObjectSampler.hh.

Constructor & Destructor Documentation

JSUPPORT::JRunByRun::JRunByRun ( )

inline

Default constructor.

Definition at line 38 of file JRunByRun.hh.

                :
      JMultipleFileSampler<JDAQSummaryslice, JRandomSampler>()
    {}

Member Function Documentation

bool JSUPPORT::JRunByRun::is_valid ( ) const

inline

Check validity of run by run options.

Returns

true if okay; else false

Definition at line 48 of file JRunByRun.hh.

    {
      return !(*this)->getFilelist().empty();
    }

template<class T >

static JProperties JSUPPORT::JRunByRun::getProperties ( T &  object )

inlinestaticprotected

Get properties of this class.

Parameters

object

class object

Returns

properties

Definition at line 98 of file JRunByRun.hh.

    {
      JProperties properties;

      properties["file"]     = object->getFilelist();
      properties["sampler"]  = object.getSampler();

      return properties;
    }

const JMultipleFileScanner<JDAQSummaryslice >* const JSUPPORT::JMultipleFileSampler_t< JDAQSummaryslice >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns

pointer to scanner

Definition at line 31 of file JMultipleFileSampler.hh.

    {
      return &scanner;
    }

JMultipleFileScanner<JDAQSummaryslice >* JSUPPORT::JMultipleFileSampler_t< JDAQSummaryslice >::operator-> ( )

inlineinherited

Smart pointer operator.

Returns

pointer to scanner

Definition at line 41 of file JMultipleFileSampler.hh.

    {
      return &scanner;
    }

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

virtual bool JLANG::JObjectSampler< T, JSampler_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 78 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;
    }

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

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

inlineoverridevirtualinherited

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 120 of file JObjectSampler.hh.

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

      has_next = false;
      
      return ps;
    }

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

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

inlineinherited

Get sampler.

Returns

sampler

Definition at line 137 of file JObjectSampler.hh.

    {
      return sampler;
    }

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

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

inlineinherited

Get sampler.

Returns

sampler

Definition at line 148 of file JObjectSampler.hh.

    {
      return sampler;
    }

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 event_type >, JLANG::JAbstractObjectReader< JNullType >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::KM3NETDAQ::JDAQEvent >, and JLANG::JAbstractObjectReader< JDAQSummaryslice >.

Definition at line 90 of file JObjectIterator.hh.

    {
      skip_type i = 0;

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

      return i;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JRunByRun &  object  )

friend

Read run by run options from input.

Parameters

in	input stream
object	run by run options

Returns

input stream

Definition at line 61 of file JRunByRun.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JStringStream is(in);

      if (getFileStatus(is.str().c_str())) {
        is.load();
      }

      getProperties(object).read(is);

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JRunByRun &  object  )

friend

Write run by run options to output.

Parameters

out	output stream
object	run by run options

Returns

output stream

Definition at line 85 of file JRunByRun.hh.

    {
      return getProperties(object).write(out);
    }

Member Data Documentation

JMultipleFileScanner<JDAQSummaryslice > JSUPPORT::JMultipleFileSampler_t< JDAQSummaryslice >::scanner

protectedinherited

Definition at line 47 of file JMultipleFileSampler.hh.

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

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

protectedinherited

Definition at line 154 of file JObjectSampler.hh.

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

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

protectedinherited

Definition at line 155 of file JObjectSampler.hh.

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

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

protectedinherited

Definition at line 156 of file JObjectSampler.hh.

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

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

protectedinherited

Definition at line 157 of file JObjectSampler.hh.

---

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

• JRunByRun.hh