Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
JTRIGGER::JRunByRun Struct Reference

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

#include <JRunByRun.hh>

Inheritance diagram for JTRIGGER::JRunByRun:
JSUPPORT::JMultipleFileSampler< T, JSampler_t > JLANG::JMultiEquals< JClass_t, JType_t > JLANG::JTemplate< JType_t > JLANG::JObjectSampler< T, JSampler_t > JLANG::JObjectIterator< T >

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

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

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

Member Typedef Documentation

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<class JType_t>
typedef JTemplate<JType_t> JLANG::JTemplate< JType_t >::template_type
inherited

Definition at line 42 of file JTemplate.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

JTRIGGER::JRunByRun::JRunByRun ( )
inline

Default constructor.

Definition at line 54 of file JRunByRun.hh.

54  :
55  JMultipleFileSampler<JDAQSummaryslice, JRandomSampler>()
56  {}

Member Function Documentation

bool JTRIGGER::JRunByRun::is_valid ( )
inline

Check validity of run by run options.

Returns
true if okay; else false

Definition at line 64 of file JRunByRun.hh.

65  {
66  return !this->template get<JMultipleFileScanner<>,true>().empty();
67  }
template<class T >
static JProperties JTRIGGER::JRunByRun::getProperties ( T &  object)
inlinestaticprotected

Get properties of this class.

Returns
properties

Definition at line 113 of file JRunByRun.hh.

114  {
115  JProperties properties;
116 
117  properties["file"] = object.template get<JMultipleFileScanner<>,true>();
118  properties["sampler"] = object.getSampler();
119 
120  return properties;
121  }
JEEP::JProperties
Utility class to parse parameter values.
Definition: JProperties.hh:496
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.

69  {
70  return object;
71  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
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.

80  {
81  return object;
82  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
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.

91  {
92  return &object;
93  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
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.

102  {
103  return &object;
104  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
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.

114  {
115  return this->c_get(JBool<use_polymorphism>().template c_switch<JConversion<JType_t, T>::is_derived, JConversion<JType_t, T>::is_same>());
116  }
JLANG::JTemplate::c_get
const JType_t & c_get(JBool< true > option) const
Get reference to object.
Definition: JTemplate.hh:188
JLANG::JConversion
Template class test for polymorphism.
Definition: JConversion.hh:21
JLANG::JBool
Auxiliary template class for type bool.
Definition: JBool.hh:20
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.

126  {
127  return this->c_get(JBool<use_polymorphism>().template c_switch<JConversion<JType_t, T>::is_derived, JConversion<JType_t, T>::is_same>());
128  }
JLANG::JTemplate::c_get
const JType_t & c_get(JBool< true > option) const
Get reference to object.
Definition: JTemplate.hh:188
JLANG::JConversion
Template class test for polymorphism.
Definition: JConversion.hh:21
JLANG::JBool
Auxiliary template class for type bool.
Definition: JBool.hh:20
template<class JType_t>
template_type& JLANG::JTemplate< JType_t >::set ( const JType_t &  value)
inlineinherited

Set value.

Parameters
valuevalue
Returns
this object

Definition at line 137 of file JTemplate.hh.

138  {
139  return c_set(value, JBool<true>());
140  }
JLANG::JTemplate::c_set
template_type & c_set(const T &value, JBool< true > option)
Set value.
Definition: JTemplate.hh:214
JLANG::JBool
Auxiliary template class for type bool.
Definition: JBool.hh:20
template<class JType_t>
template<bool use_polymorphism, class T >
template_type& JLANG::JTemplate< JType_t >::set ( const T &  value)
inlineinherited

Set value.

Parameters
valuevalue
Returns
this object

Definition at line 150 of file JTemplate.hh.

151  {
152  return this->c_set(value, JBool<use_polymorphism>::template c_switch<JConstructor<JType_t, T>::has_constructor, JConversion<JType_t, T>::is_same>());
153  }
JLANG::JTemplate::c_set
template_type & c_set(const T &value, JBool< true > option)
Set value.
Definition: JTemplate.hh:214
JLANG::JConversion
Template class test for polymorphism.
Definition: JConversion.hh:21
JLANG::JBool
Auxiliary template class for type bool.
Definition: JBool.hh:20
JLANG::JConstructor
Template class test for availability of a suitable constructor JType_t(const JArgument_t).
Definition: JConstructor.hh:19
template<class JType_t>
const JType_t& JLANG::JTemplate< JType_t >::c_get ( JBool< true >  option) const
inlineprotectedinherited

Get reference to object.

Parameters
optiontrue
Returns
reference to object

Definition at line 188 of file JTemplate.hh.

189  {
190  return object;
191  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
template<class JType_t>
JType_t& JLANG::JTemplate< JType_t >::c_get ( JBool< true >  option)
inlineprotectedinherited

Get reference to object.

Parameters
optiontrue
Returns
reference to object

Definition at line 200 of file JTemplate.hh.

201  {
202  return object;
203  }
JLANG::JTemplate::object
JType_t object
object
Definition: JTemplate.hh:222
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
valuevalue
optiontrue
Returns
this object

Definition at line 214 of file JTemplate.hh.

215  {
216  object = value;
217 
218  return *this;
219  }
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.

79  {
80  while (!has_next) {
81 
82  if (!in.hasNext()) {
83  in.rewind();
84  }
85 
86  if (in.hasNext()) {
87 
88  ps.set(in.next());
89 
90  skip_type ns = sampler(*ps);
91 
92  if (ns == 0) {
93 
94  has_next = true;
95 
96  } else {
97 
98  while ((ns -= in.skip(ns)) != 0) {
99  in.rewind();
100  }
101  }
102 
103  } else {
104 
105  // nothing to sample
106 
107  break;
108  }
109  }
110 
111  return has_next;
112  }
JLANG::skip_type
unsigned int skip_type
Type definition for number of objects to skip.
Definition: JObjectIterator.hh:25
JLANG::JObjectSampler::in
JRewindableObjectIterator< T > & in
Definition: JObjectSampler.hh:154
JLANG::JObjectSampler::sampler
JSampler_t< T > sampler
Definition: JObjectSampler.hh:155
JLANG::JPointer::set
virtual void set(JClass_t *p)
Set pointer.
Definition: JPointer.hh:75
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.

121  {
122  if (!has_next) {
123  ps.reset(NULL);
124  }
125 
126  has_next = false;
127 
128  return ps;
129  }
JLANG::JPointer::reset
virtual void reset()
Reset pointer.
Definition: JPointer.hh:84
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.

138  {
139  return sampler;
140  }
JLANG::JObjectSampler::sampler
JSampler_t< T > sampler
Definition: JObjectSampler.hh:155
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.

149  {
150  return sampler;
151  }
JLANG::JObjectSampler::sampler
JSampler_t< T > sampler
Definition: JObjectSampler.hh:155
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::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JSTDObjectIterator< T >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< JNullType >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::KM3NETDAQ::JDAQEvent >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, and JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 88 of file JObjectIterator.hh.

89  {
90  skip_type i = 0;
91 
92  for ( ; i != ns && hasNext(); ++i) {
93  next();
94  }
95 
96  return i;
97  }
JLANG::skip_type
unsigned int skip_type
Type definition for number of objects to skip.
Definition: JObjectIterator.hh:25
JLANG::JObjectIterator::next
virtual const pointer_type & next()=0
Get next element.
JLANG::JObjectIterator::hasNext
virtual bool hasNext()=0
Check availability of next element.

Friends And Related Function Documentation

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

Read run by run options from input.

Parameters
ininput stream
objectrun by run options
Returns
input stream

Definition at line 77 of file JRunByRun.hh.

78  {
79  using namespace std;
80  using namespace JPP;
81 
82  JStringStream is(in);
83 
84  if (getFileStatus(is.str().c_str())) {
85  is.load();
86  }
87 
88  getProperties(object).read(is);
89 
90  return in;
91  }
JEEP::JProperties::read
bool read(const JEquation &equation)
Read equation.
Definition: JProperties.hh:677
JLANG::JObjectSampler::in
JRewindableObjectIterator< T > & in
Definition: JObjectSampler.hh:154
is
is
Definition: JDAQCHSM.chsm:167
JTRIGGER::JRunByRun::getProperties
static JProperties getProperties(T &object)
Get properties of this class.
Definition: JRunByRun.hh:113
JSYSTEM::getFileStatus
static JStat getFileStatus
Function object for file status.
Definition: JStat.hh:173
JLANG::JStringStream
Wrapper class around STL stringstream class to facilitate optional loading of data from file...
Definition: JStringStream.hh:22
std::ostream& operator<< ( std::ostream &  out,
const JRunByRun &  object 
)
friend

Write run by run options to output.

Parameters
outoutput stream
objectrun by run options
Returns
output stream

Definition at line 101 of file JRunByRun.hh.

102  {
103  return getProperties(object).write(out);
104  }
JTRIGGER::JRunByRun::getProperties
static JProperties getProperties(T &object)
Get properties of this class.
Definition: JRunByRun.hh:113
JEEP::JProperties::write
std::ostream & write(std::ostream &out) const
Write the current parameter values.
Definition: JProperties.hh:845

Member Data Documentation

template<class JType_t>
JType_t JLANG::JTemplate< JType_t >::object
protectedinherited

object

Definition at line 222 of file JTemplate.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:
Generated by   doxygen 1.8.5