Auxiliary class to handle run by run options. More...

#include <JRunByRun.hh>

Inheritance diagram for JTRIGGER::JRunByRun:

Public Types
typedef JSampler_t< T >	sampler_type

typedef JTemplate< JType_t >	template_type

typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JRunByRun ()
	Default constructor. More...

bool	is_valid ()
	Check validity of run by run options. More...

	operator const JType_t & () const
	Type conversion. More...

	operator JType_t & ()
	Type conversion. More...

const JType_t *	operator-> () const
	Smart pointer operator. More...

JType_t *	operator-> ()
	Smart pointer operator. More...

template<class T , bool use_polymorphism = false>
const T &	get () const
	Get reference to object. More...

template<class T , bool use_polymorphism = false>
T &	get ()
	Get reference to object. More...

template_type &	set (const JType_t &value)
	Set value. More...

template<bool use_polymorphism, class T >
template_type &	set (const T &value)
	Set value. 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...

Public Attributes
JPMTRateRange	range_Hz

Protected Member Functions
const JType_t &	c_get (JBool< true > option) const
	Get reference to object. More...

JType_t &	c_get (JBool< true > option)
	Get reference to object. More...

template<class T >
template_type &	c_set (const T &value, JBool< true > option)
	Set value. More...

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

template<class JHead_t , class JTail_t >
static bool	eq (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JTail_t > > &type)
	Equals method for composite data types. More...

template<class JHead_t >
static bool	eq (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JNullType > > &type)
	Equals method for composite data types. More...

Protected Attributes
JType_t	object
	object More...

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 handle run by run options.

This class is used in e.g. JTriggerEfficiency.cc in run-by-run mode to select summary data (KM3NETDAQ::JDAQSummaryslice) from the specified raw data file(s).
The two parameters of the JSUPPORT::JRandomSampler class should therefore 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).
The range of acceptable rates (JRunByRun::range_Hz) was originally used to define "working" PMTs.
With the use of the hardware high-rate veto and FIFO (almost) full information, this criterion is redundant.
Note that the range is applied to the rate of photo-electrons (i.e. before the application of QE, etc.).
It is therefore recommended to set this range sufficiently wide to avoid interference with the simulation of the PMT response.

Definition at line 50 of file JRunByRun.hh.

Member Typedef Documentation

◆ sampler_type

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

typedef JSampler_t<T> JSUPPORT::JMultipleFileSampler< T, JSampler_t >::sampler_type

inherited

Definition at line 33 of file JMultipleFileSampler.hh.

◆ template_type

template<class JType_t>

typedef JTemplate<JType_t> JLANG::JTemplate< JType_t >::template_type

inherited

Definition at line 42 of file JTemplate.hh.

◆ pointer_type

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

◆ JRunByRun()

JTRIGGER::JRunByRun::JRunByRun ( )

inline

Default constructor.

Definition at line 57 of file JRunByRun.hh.

                 :
       JMultipleFileSampler<JDAQSummaryslice, JRandomSampler>(),
       range_Hz()
     {}

Member Function Documentation

◆ is_valid()

bool JTRIGGER::JRunByRun::is_valid ( )

inline

Check validity of run by run options.

Returns: true if okay; else false

Definition at line 68 of file JRunByRun.hh.

     {
       return !this->template get<JMultipleFileScanner<>,true>().empty();
     }

◆ getProperties()

template<class T >

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

inlinestaticprotected

Get properties of this class.

Returns: properties

Definition at line 120 of file JRunByRun.hh.

     {
       JProperties properties;
  
       properties["file"]     = object.template get<JMultipleFileScanner<>,true>();
       properties["sampler"]  = object.getSampler();
       properties["range_Hz"] = object.range_Hz;
  
       return properties;
     }

◆ operator const JType_t &()

template<class JType_t>

JLANG::JTemplate< JType_t >::operator const JType_t & ( ) const

inlineinherited

Type conversion.

Returns: reference to object

Definition at line 68 of file JTemplate.hh.

     {
       return object;
     }

◆ operator JType_t &()

template<class JType_t>

JLANG::JTemplate< JType_t >::operator JType_t & ( )

inlineinherited

Type conversion.

Returns: reference to object

Definition at line 79 of file JTemplate.hh.

     {
       return object;
     }

◆ operator->() [1/2]

template<class JType_t>

const JType_t* JLANG::JTemplate< JType_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 90 of file JTemplate.hh.

     { 
       return &object;
     }

◆ operator->() [2/2]

template<class JType_t>

JType_t* JLANG::JTemplate< JType_t >::operator-> ( )

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 101 of file JTemplate.hh.

     { 
       return &object;
     }

◆ get() [1/2]

template<class JType_t>

template<class T , bool use_polymorphism = false>

const T& JLANG::JTemplate< JType_t >::get ( ) const

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 113 of file JTemplate.hh.

     {
       return this->c_get(JBool<use_polymorphism>().template c_switch<JConversion<JType_t, T>::is_derived, JConversion<JType_t, T>::is_same>());
     }

◆ get() [2/2]

template<class JType_t>

template<class T , bool use_polymorphism = false>

T& JLANG::JTemplate< JType_t >::get ( )

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 125 of file JTemplate.hh.

     {
       return this->c_get(JBool<use_polymorphism>().template c_switch<JConversion<JType_t, T>::is_derived, JConversion<JType_t, T>::is_same>());
     }

◆ set() [1/2]

template<class JType_t>

template_type& JLANG::JTemplate< JType_t >::set ( const JType_t & value )

inlineinherited

Set value.

Parameters

value value

Returns: this object

Definition at line 137 of file JTemplate.hh.

     {
       return c_set(value, JBool<true>());
     }

◆ set() [2/2]

template<class JType_t>

template<bool use_polymorphism, class T >

template_type& JLANG::JTemplate< JType_t >::set ( const T & value )

inlineinherited

Set value.

Parameters

value value

Returns: this object

Definition at line 150 of file JTemplate.hh.

     {
       return this->c_set(value, JBool<use_polymorphism>::template c_switch<JConstructor<JType_t, T>::has_constructor, JConversion<JType_t, T>::is_same>());
     }

◆ c_get() [1/2]

template<class JType_t>

const JType_t& JLANG::JTemplate< JType_t >::c_get ( JBool< true > option ) const

inlineprotectedinherited

Get reference to object.

Parameters

option true

Returns: reference to object

Definition at line 188 of file JTemplate.hh.

     {
       return object;
     }

◆ c_get() [2/2]

template<class JType_t>

JType_t& JLANG::JTemplate< JType_t >::c_get ( JBool< true > option )

inlineprotectedinherited

Get reference to object.

Parameters

option true

Returns: reference to object

Definition at line 200 of file JTemplate.hh.

     {
       return object;
     }

◆ c_set()

template<class JType_t>

template<class T >

template_type& JLANG::JTemplate< JType_t >::c_set	(	const T &	value,
		JBool< true >	option
	)

inlineprotectedinherited

Set value.

Parameters

value	value
option	true

Returns: this object

Definition at line 214 of file JTemplate.hh.

     {
       object = value;
  
       return *this;
     }

◆ hasNext()

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

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

inlinevirtualinherited

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;
     }

◆ next()

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

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

inlinevirtualinherited

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;
     }

◆ getSampler() [1/2]

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;
     }

◆ getSampler() [2/2]

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;
     }

◆ 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;
     }

◆ eq() [1/2]

template<class JClass_t, class JTypelist_t>

template<class JHead_t , class JTail_t >

static bool JLANG::JMultiEquals< JClass_t, JTypelist_t >::eq	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JTail_t > > &	type
	)

inlinestaticprotectedinherited

Equals method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if two objects are equal; else false

Definition at line 42 of file JMultiEquals.hh.

     {
       return (static_cast<const JHead_t&>(first)  ==
               static_cast<const JHead_t&>(second) &&
               eq(first, second, JType<JTail_t>()));
     }

◆ eq() [2/2]

template<class JClass_t, class JTypelist_t>

template<class JHead_t >

static bool JLANG::JMultiEquals< JClass_t, JTypelist_t >::eq	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JNullType > > &	type
	)

inlinestaticprotectedinherited

Equals method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if two objects are equal; else false

Definition at line 61 of file JMultiEquals.hh.

     {
       return (static_cast<const JHead_t&>(first) ==
               static_cast<const JHead_t&>(second));
     }

Friends And Related Function Documentation

◆ operator>>

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 81 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;
     }

◆ operator<<

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 105 of file JRunByRun.hh.

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

Member Data Documentation

◆ range_Hz

JPMTRateRange JTRIGGER::JRunByRun::range_Hz

Definition at line 111 of file JRunByRun.hh.

◆ object

template<class JType_t>

JType_t JLANG::JTemplate< JType_t >::object

protectedinherited

object

Definition at line 222 of file JTemplate.hh.

◆ in

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.

◆ sampler

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.

◆ ps

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.

◆ has_next

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ sampler_type

◆ template_type

◆ pointer_type

Constructor & Destructor Documentation

◆ JRunByRun()

Member Function Documentation

◆ is_valid()

◆ getProperties()

◆ operator const JType_t &()

◆ operator JType_t &()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ c_get() [1/2]

◆ c_get() [2/2]

◆ c_set()

◆ hasNext()

◆ next()

◆ getSampler() [1/2]

◆ getSampler() [2/2]

◆ skip()

◆ eq() [1/2]

◆ eq() [2/2]

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ range_Hz

◆ object

◆ in

◆ sampler

◆ ps

◆ has_next