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

#include <JTriggerParametersSupportkit.hh>

Inheritance diagram for JSUPPORT::JMultipleFileScanner< JTriggerParameters >:

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 () override
	Rewind. More...

virtual bool	setObject (JTriggerParameters &object) override
	Set object. More...

const JTriggerParameters &	getTriggerParameters ()
	Get trigger parameters. More...

const std::string &	getFilename () const
	Get current file name. More...

counter_type	getCounter () const
	Get counter. More...

virtual bool	hasNext () override
	Check availability of next element. More...

virtual const pointer_type &	next () override
	Get next element. More...

virtual skip_type	skip (const skip_type ns) override
	Skip items. More...

virtual skip_type	skip (const skip_type ns)
	Skip items. More...

virtual bool	hasNext () override
	Check availability of next element. More...

virtual const pointer_type &	next () override
	Get next element. More...

virtual bool	setObject (T &object)=0
	Set object. More...

Protected Attributes
JFileScanner< T >	scanner

unsigned int	index

counter_type	counter

T	object
	object More...

bool	has_next
	status More...

Private Attributes
bool	do_next

pointer_type	ps

Detailed Description

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

typedef JMultipleFileScanner ::input_type JSUPPORT::JMultipleFileScanner< T >::input_type

inherited

Definition at line 309 of file JMultipleFileScanner.hh.

◆ pointer_type [1/2]

typedef JRewindableObjectIterator<T>::pointer_type JSUPPORT::JMultipleFileScanner< T >::pointer_type

inherited

Definition at line 310 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]

JSUPPORT::JMultipleFileScanner< JTriggerParameters >::JMultipleFileScanner ( )

inline

Default constructor.

Definition at line 40 of file JTriggerParametersSupportkit.hh.

                            :
       JMultipleFileScanner<>(),
       JRewindableAbstractObjectIterator<JTriggerParameters>(),
       do_next(true)
     {}

◆ JMultipleFileScanner() [2/2]

JSUPPORT::JMultipleFileScanner< JTriggerParameters >::JMultipleFileScanner ( const JMultipleFileScanner_t & file_list )

inline

Copy constructor.

The file list is copied.

Parameters

file_list JMultipleFileScanner

Definition at line 53 of file JTriggerParametersSupportkit.hh.

                                                                   :
       JMultipleFileScanner<>(),
       JRewindableAbstractObjectIterator<JTriggerParameters>(),
       do_next(true)
     {
       configure(file_list, JLimit());
     }

Member Function Documentation

◆ rewind()

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

inlineoverridevirtual

Rewind.

Reimplemented from JSUPPORT::JMultipleFileScanner<>.

Definition at line 65 of file JTriggerParametersSupportkit.hh.

     {
       do_next = true;
     }

◆ setObject() [1/2]

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

inlineoverridevirtual

Set object.

Parameters

object reference to object to be set

Returns: true if set; else false

Definition at line 77 of file JTriggerParametersSupportkit.hh.

     {
       if (do_next) {
  
         using namespace JLANG;
  
         object  = JTriggerParameters();
         do_next = false;
  
         unsigned int count = 0;
  
         JFileScanner<JTriggerParameters> scanner;
  
         for (const_iterator i = this->begin(); i != this->end(); ++i) {
  
           scanner.open(i->c_str());
  
           if (scanner.hasNext()) {
  
             const JTriggerParameters* __p = scanner.next();
             
             if      (count == 0)
               object  =  *__p;
             else if (!object.equals(*__p))
               THROW(JException, "JMultipleFileScanner<JTriggerParameters>::setObject(): inconsistent trigger parameters.");
  
             ++count;
           }
           
           scanner.close();
         }
  
         return count != 0;
  
       } else {
  
         return false;
       }
     }

◆ getTriggerParameters()

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

inline

Get trigger parameters.

Returns: trigger parameters

Definition at line 123 of file JTriggerParametersSupportkit.hh.

     {
       const JTriggerParameters* p = NULL;
  
       if (!this->hasNext() || (p = this->next()) == NULL) {
         THROW(JNullPointerException, "JMultipleFileScanner<JTriggerParameters>::getTriggerParameters(): Missing trigger parameters.");
       }
  
       rewind();
  
       return *p;
     }

◆ 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 371 of file JMultipleFileScanner.hh.

     {
       return this->at(index);
     }

◆ getCounter()

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

inlineinherited

Get counter.

Returns: counter

Definition at line 382 of file JMultipleFileScanner.hh.

     {
       return counter;
     }

◆ hasNext() [1/2]

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

     {
       if (is_valid()) {
  
         if (counter < getUpperLimit() && index != this->size()) {
  
           // first time around
  
           if (!scanner.is_open()) {
             scanner.open(getFilename().c_str());
           }
           
           if (counter < getLowerLimit()) {
             counter += scanner.skip(getLowerLimit() - counter);
           }     
  
           if (!scanner.hasNext()) {
             
             scanner.close();
             
             ++index;
             
             return hasNext();
           }
  
           return true;
  
         } else {
  
           // last time around
  
           if (scanner.is_open()) {
             scanner.close();
           }
  
           scanner.reset();
         }
       }
  
       return false;
     }

◆ next() [1/2]

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

inlineoverridevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 457 of file JMultipleFileScanner.hh.

     {
       ++counter;
  
       return scanner.next();
     }

◆ skip() [1/2]

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

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

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

Definition at line 471 of file JMultipleFileScanner.hh.

     {
       skip_type i = 0;
  
       while (this->hasNext() && i != ns) {
         i += scanner.skip(ns - i);
       }
  
       counter += i;
  
       return i;
     }

◆ skip() [2/2]

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::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

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

◆ hasNext() [2/2]

template<class T >

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

     {
       if (!has_next) {
         has_next = this->setObject(object);
       }
  
       return has_next;
     }

◆ next() [2/2]

template<class T >

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

inlineoverridevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

     {
       if (has_next)
         ps.reset(&this->object);
       else
         ps.reset(NULL);
  
       has_next = false;
       
       return ps;
     }

◆ setObject() [2/2]

template<class T >

virtual bool JLANG::JAbstractObjectIterator< T >::setObject ( T & object )

pure virtualinherited

Set object.

Parameters

object reference to object to be set

Returns: true if set; else false

Implemented in JSUPPORT::JDAQFileReader< T, true >, JNET::JLigierObjectIterator< T >, JNET::JControlHostObjectIterator< T >, JLANG::JStreamObjectIterator< T >, JIO::JReaderObjectIterator< T >, and JDATABASE::JDatabaseObjectIterator< T >.

Member Data Documentation

◆ do_next

bool JSUPPORT::JMultipleFileScanner< JTriggerParameters >::do_next

private

Definition at line 138 of file JTriggerParametersSupportkit.hh.

◆ scanner

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

protectedinherited

Definition at line 486 of file JMultipleFileScanner.hh.

◆ index

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

protectedinherited

Definition at line 487 of file JMultipleFileScanner.hh.

◆ counter

counter_type JSUPPORT::JMultipleFileScanner< T >::counter

protectedinherited

Definition at line 488 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:

JTriggerParametersSupportkit.hh

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ input_type

◆ pointer_type [1/2]

◆ pointer_type [2/2]

Constructor & Destructor Documentation

◆ JMultipleFileScanner() [1/2]

◆ JMultipleFileScanner() [2/2]

Member Function Documentation

◆ rewind()

◆ setObject() [1/2]

◆ getTriggerParameters()

◆ getFilename()

◆ getCounter()

◆ hasNext() [1/2]

◆ next() [1/2]

◆ skip() [1/2]

◆ skip() [2/2]

◆ hasNext() [2/2]

◆ next() [2/2]

◆ setObject() [2/2]

Member Data Documentation

◆ do_next

◆ scanner

◆ index

◆ counter

◆ object

◆ has_next

◆ ps