Jpp
Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
JSUPPORT::JMultipleFileScanner< JTriggerParameters > Class Template Referenceabstract

Template specialisation of JMultipleFileScanner for trigger parameters. More...

#include <JTriggerParametersSupportkit.hh>

Inheritance diagram for JSUPPORT::JMultipleFileScanner< JTriggerParameters >:
JSUPPORT::JMultipleFileScanner<> JLANG::JRewindableAbstractObjectIterator< T > JLANG::JRewindableObjectIterator< T > JLANG::JRewindableObjectIterator< T > JLANG::JAbstractObjectIterator< T > JLANG::JObjectIterator< T > JLANG::JRewindable< T > JLANG::JObjectIterator< T > JLANG::JRewindable< T > JLANG::JObjectIterator< T >

Public Types

typedef JMultipleFileScanner ::input_type input_type
 
typedef JRewindableObjectIterator< T >::pointer_type pointer_type
 
typedef JObjectIterator< T >::pointer_type pointer_type
 

Public Member Functions

 JMultipleFileScanner ()
 Default constructor. More...
 
 JMultipleFileScanner (const JMultipleFileScanner_t &file_list)
 Copy constructor. More...
 
virtual void rewind ()
 Rewind. More...
 
virtual bool setObject (JTriggerParameters &object)
 Set object. More...
 
const JTriggerParametersgetTriggerParameters ()
 Get trigger parameters. More...
 
const std::string & getFilename () const
 Get current file name. More...
 
counter_type getCounter () const
 Get counter. More...
 
virtual bool hasNext ()
 Check availability of next element. More...
 
virtual const pointer_typenext ()
 Get next element. More...
 
virtual skip_type skip (const skip_type ns)
 Skip items. More...
 
virtual skip_type skip (const skip_type ns)
 Skip items. More...
 
virtual bool hasNext ()
 Check availability of next element. More...
 
virtual const pointer_typenext ()
 Get next element. More...
 
virtual bool setObject (T &object)=0
 Set object. More...
 

Protected Attributes

JFileScanner< T > scanner
 
unsigned int index
 
counter_type counter
 
object
 object More...
 
bool has_next
 status More...
 

Private Attributes

bool do_next
 
pointer_type ps
 

Detailed Description

template<>
class JSUPPORT::JMultipleFileScanner< JTriggerParameters >

Template specialisation of JMultipleFileScanner for trigger parameters.

This class re-implements the methods rewind and setObject of the JLANG::JRewindableAbstractObjectIterator interface so that all trigger parameter objects in the complete file list are read and checked for consistency.

Definition at line 32 of file JTriggerParametersSupportkit.hh.

Member Typedef Documentation

◆ input_type

Definition at line 263 of file JMultipleFileScanner.hh.

◆ pointer_type [1/2]

Definition at line 264 of file JMultipleFileScanner.hh.

◆ pointer_type [2/2]

template<class T>
typedef JObjectIterator<T>::pointer_type JLANG::JAbstractObjectIterator< T >::pointer_type
inherited

Definition at line 39 of file JAbstractObjectIterator.hh.

Constructor & Destructor Documentation

◆ JMultipleFileScanner() [1/2]

Default constructor.

Definition at line 40 of file JTriggerParametersSupportkit.hh.

◆ JMultipleFileScanner() [2/2]

Copy constructor.

The file list is copied.

Parameters
file_listJMultipleFileScanner

Definition at line 53 of file JTriggerParametersSupportkit.hh.

53  :
56  do_next(true)
57  {
58  configure(file_list, JLimit());
59  }

Member Function Documentation

◆ rewind()

virtual void JSUPPORT::JMultipleFileScanner< JTriggerParameters >::rewind ( )
inlinevirtual

Rewind.

Reimplemented from JSUPPORT::JMultipleFileScanner<>.

Definition at line 65 of file JTriggerParametersSupportkit.hh.

66  {
67  do_next = true;
68  }

◆ setObject() [1/2]

virtual bool JSUPPORT::JMultipleFileScanner< JTriggerParameters >::setObject ( JTriggerParameters object)
inlinevirtual

Set object.

Parameters
objectreference to object to be set
Returns
true if set; else false

Definition at line 77 of file JTriggerParametersSupportkit.hh.

78  {
79  if (do_next) {
80 
81  using namespace JLANG;
82 
83  object = JTriggerParameters();
84  do_next = false;
85 
86  unsigned int count = 0;
87 
89 
90  for (const_iterator i = this->begin(); i != this->end(); ++i) {
91 
92  scanner.open(i->c_str());
93 
94  if (scanner.hasNext()) {
95 
96  const JTriggerParameters* __p = scanner.next();
97 
98  if (count == 0)
99  object = *__p;
100  else if (!object.equals(*__p))
101  throw JException("JMultipleFileScanner<JTriggerParameters>::setObject(): inconsistent trigger parameters.");
102 
103  ++count;
104  }
105 
106  scanner.close();
107  }
108 
109  return count != 0;
110 
111  } else {
112 
113  return false;
114  }
115  }

◆ getTriggerParameters()

const JTriggerParameters& JSUPPORT::JMultipleFileScanner< JTriggerParameters >::getTriggerParameters ( )
inline

Get trigger parameters.

Returns
trigger parameters

Definition at line 123 of file JTriggerParametersSupportkit.hh.

124  {
125  const JTriggerParameters* p = NULL;
126 
127  if (!this->hasNext() || (p = this->next()) == NULL) {
128  throw JNullPointerException("JMultipleFileScanner<JTriggerParameters>::getTriggerParameters(): Missing trigger parameters.");
129  }
130 
131  rewind();
132 
133  return *p;
134  }

◆ getFilename()

const std::string& JSUPPORT::JMultipleFileScanner< T >::getFilename ( ) const
inlineinherited

Get current file name.

Note that this method should only be called when method hasNext() returns true.

Returns
file name

Definition at line 312 of file JMultipleFileScanner.hh.

313  {
314  return this->at(index);
315  }

◆ getCounter()

counter_type JSUPPORT::JMultipleFileScanner< T >::getCounter ( ) const
inlineinherited

Get counter.

Returns
counter

Definition at line 323 of file JMultipleFileScanner.hh.

324  {
325  return counter;
326  }

◆ hasNext() [1/2]

virtual bool JSUPPORT::JMultipleFileScanner< 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 350 of file JMultipleFileScanner.hh.

351  {
352  if (is_valid()) {
353 
354  if (counter < getUpperLimit() && index != this->size()) {
355 
356  // first time around
357 
358  if (!scanner.is_open()) {
359  scanner.open(getFilename().c_str());
360  }
361 
362  if (counter < getLowerLimit()) {
363  counter += scanner.skip(getLowerLimit() - counter);
364  }
365 
366  if (!scanner.hasNext()) {
367 
368  scanner.close();
369 
370  ++index;
371 
372  return hasNext();
373  }
374 
375  return true;
376 
377  } else {
378 
379  // last time around
380 
381  if (scanner.is_open()) {
382  scanner.close();
383  }
384 
385  scanner.reset();
386  }
387  }
388 
389  return false;
390  }

◆ next() [1/2]

virtual const pointer_type& JSUPPORT::JMultipleFileScanner< T >::next ( )
inlinevirtualinherited

Get next element.

Returns
pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 398 of file JMultipleFileScanner.hh.

399  {
400  ++counter;
401 
402  return scanner.next();
403  }

◆ skip() [1/2]

virtual skip_type JSUPPORT::JMultipleFileScanner< T >::skip ( const skip_type  ns)
inlinevirtualinherited

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Reimplemented in JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >.

Definition at line 412 of file JMultipleFileScanner.hh.

413  {
414  skip_type i = 0;
415 
416  while (this->hasNext() && i != ns) {
417  i += scanner.skip(ns - i);
418  }
419 
420  counter += i;
421 
422  return i;
423  }

◆ skip() [2/2]

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

◆ hasNext() [2/2]

template<class T>
virtual bool JLANG::JAbstractObjectIterator< 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 56 of file JAbstractObjectIterator.hh.

57  {
58  if (!has_next) {
59  has_next = this->setObject(object);
60  }
61 
62  return has_next;
63  }

◆ next() [2/2]

template<class T>
virtual const pointer_type& JLANG::JAbstractObjectIterator< T >::next ( )
inlinevirtualinherited

Get next element.

Returns
pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

72  {
73  if (has_next)
74  ps.reset(&this->object);
75  else
76  ps.reset(NULL);
77 
78  has_next = false;
79 
80  return ps;
81  }

◆ setObject() [2/2]

template<class T>
virtual bool JLANG::JAbstractObjectIterator< T >::setObject ( T &  object)
pure virtualinherited

Member Data Documentation

◆ do_next

Definition at line 138 of file JTriggerParametersSupportkit.hh.

◆ scanner

JFileScanner<T> JSUPPORT::JMultipleFileScanner< T >::scanner
protectedinherited

Definition at line 427 of file JMultipleFileScanner.hh.

◆ index

unsigned int JSUPPORT::JMultipleFileScanner< T >::index
protectedinherited

Definition at line 428 of file JMultipleFileScanner.hh.

◆ counter

counter_type JSUPPORT::JMultipleFileScanner< T >::counter
protectedinherited

Definition at line 429 of file JMultipleFileScanner.hh.

◆ object

template<class T>
T JLANG::JAbstractObjectIterator< T >::object
protectedinherited

object

Definition at line 34 of file JAbstractObjectIterator.hh.

◆ has_next

template<class T>
bool JLANG::JAbstractObjectIterator< T >::has_next
protectedinherited

status

Definition at line 35 of file JAbstractObjectIterator.hh.

◆ ps

template<class T>
pointer_type JLANG::JAbstractObjectIterator< T >::ps
privateinherited

Definition at line 84 of file JAbstractObjectIterator.hh.


The documentation for this class was generated from the following file:
JLANG::skip_type
unsigned int skip_type
Type definition for number of objects to skip.
Definition: JObjectIterator.hh:25
JSUPPORT::JFileScanner
Object reading from file.
Definition: JFileScanner.hh:34
JSUPPORT::JLimit
Auxiliary class for defining the range of iterations of objects.
Definition: JLimit.hh:41
JSUPPORT::JMultipleFileScanner<>::counter
counter_type counter
Definition: JMultipleFileScanner.hh:429
JAANET::is_valid
bool is_valid(const T &value)
Check validity of given value.
Definition: JHead.hh:823
JSUPPORT::JMultipleFileScanner<>::getFilename
const std::string & getFilename() const
Get current file name.
Definition: JMultipleFileScanner.hh:312
JLANG::JRewindableAbstractObjectIterator< JTriggerParameters >
JLANG::JNullPointerException
Exception for null pointer operation.
Definition: JException.hh:216
JMATH::equals
bool equals(const JFirst_t &first, const JSecond_t &second, const double precision=std::numeric_limits< double >::min())
Check equality.
Definition: JMathToolkit.hh:85
JLANG::JObjectIterator::hasNext
virtual bool hasNext()=0
Check availability of next element.
JSUPPORT::JMultipleFileScanner<>::index
unsigned int index
Definition: JMultipleFileScanner.hh:428
JSUPPORT::JMultipleFileScanner<>::next
virtual const pointer_type & next()
Get next element.
Definition: JMultipleFileScanner.hh:398
JLANG::JPointer::reset
virtual void reset()
Reset pointer.
Definition: JPointer.hh:84
JLANG::JAbstractObjectIterator::has_next
bool has_next
status
Definition: JAbstractObjectIterator.hh:35
JLANG::JAbstractObjectIterator::ps
pointer_type ps
Definition: JAbstractObjectIterator.hh:84
JSUPPORT::JMultipleFileScanner<>::hasNext
virtual bool hasNext()
Check availability of next element.
Definition: JMultipleFileScanner.hh:350
JSUPPORT::JMultipleFileScanner<>
JLANG::JAbstractObjectIterator::setObject
virtual bool setObject(T &object)=0
Set object.
JLANG
Auxiliary classes and methods for language specific functionality.
Definition: JAbstractClass.hh:10
JSUPPORT::JMultipleFileScanner< JTriggerParameters >::do_next
bool do_next
Definition: JTriggerParametersSupportkit.hh:138
JTOOLS::configure
void configure(const T &value, const JAbstractCollection< JAbscissa_t > &bounds, JBool< false > option)
Configuration of value.
Definition: JToolsToolkit.hh:285
JLANG::JObjectIterator::next
virtual const pointer_type & next()=0
Get next element.
JLANG::JException
General exception.
Definition: JException.hh:40
JSUPPORT::JMultipleFileScanner< JTriggerParameters >::rewind
virtual void rewind()
Rewind.
Definition: JTriggerParametersSupportkit.hh:65
JSUPPORT::JMultipleFileScanner<>::scanner
JFileScanner< T > scanner
Definition: JMultipleFileScanner.hh:427