JSUPPORT::JMonteCarloGZFileReader< T > Class Template Reference

Template definition of Monte Carlo object reader for gzipped ASCII formatted file (i.e. '.gz') More...

#include <JMonteCarloFileReader.hh>

Inheritance diagram for JSUPPORT::JMonteCarloGZFileReader< T >:

Public Types
typedef JPointer< T >	pointer_type
	Type definition of pointer_type.
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
virtual bool	hasNext ()=0
	Check availability of next element.
virtual const pointer_type &	next ()=0
	Get next element.
virtual skip_type	skip (const skip_type ns)
	Skip items.
virtual bool	is_open () const =0
	Check is device is open.
virtual void	open (const char *file_name)=0
	Open device.
virtual void	close ()=0
	Close device.
virtual bool	is_open () const override
	Check is device is open.
virtual void	open (const char *file_name) override
	Open device.
virtual void	close () override
	Close device.
virtual bool	hasNext ()
	Check availability of next element.
virtual const pointer_type &	next ()
	Get next element.

Static Public Member Functions
static void	Throw (const bool option)
	Enable/disable throw option.
static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error.

Static Protected Attributes
static bool	do_throw
	throw option

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
class JSUPPORT::JMonteCarloGZFileReader< T >

Template definition of Monte Carlo object reader for gzipped ASCII formatted file (i.e. '.gz')

This class provides for a null implementation of the JLANG::JAccessibleObjectIterator interface. It should be specialised for the data types that will be read from a Monte Carlo file.

Definition at line 42 of file JMonteCarloFileReader.hh.

Member Typedef Documentation

pointer_type [1/2]

template<class T >

typedef JPointer<T> JLANG::JObjectIterator< T >::pointer_type

inherited

Type definition of pointer_type.

Definition at line 58 of file JObjectIterator.hh.

pointer_type [2/2]

template<class T >

typedef JObjectIterator<T>::pointer_type JLANG::JNullIterator< T >::pointer_type

inherited

Definition at line 331 of file JObjectIterator.hh.

Member Function Documentation

hasNext() [1/2]

template<class T >

virtual bool JLANG::JObjectIterator< T >::hasNext ( )

pure virtualinherited

Check availability of next element.

Returns

true if the iteration has more elements; else false

Implemented in JLANG::JNullIterator< T >, JLANG::JAbstractObjectIterator< T >, JLANG::JAbstractObjectIterator< Head >, JLANG::JAbstractObjectIterator< JHead_t >, JLANG::JAbstractObjectIterator< JTail_t >, JLANG::JAbstractObjectIterator< JTriggerParameters >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< JDAQSummaryslice, JRandomSampler >, JLANG::JObjectSampler< T, JSampler >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JLineAttributes, JROOT::JMarkerAttributes, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, and JSUPPORT::JSingleFileScanner<>.

next() [1/2]

template<class T >

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

pure virtualinherited

Get next element.

Returns

pointer to element

Implemented in JLANG::JNullIterator< T >, JLANG::JAbstractObjectIterator< T >, JLANG::JAbstractObjectIterator< Head >, JLANG::JAbstractObjectIterator< JHead_t >, JLANG::JAbstractObjectIterator< JTail_t >, JLANG::JAbstractObjectIterator< JTriggerParameters >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< JDAQSummaryslice, JRandomSampler >, JLANG::JObjectSampler< T, JSampler >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JLineAttributes, JROOT::JMarkerAttributes, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, and JSUPPORT::JSingleFileScanner<>.

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

Definition at line 90 of file JObjectIterator.hh.

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

is_open() [1/2]

virtual bool JLANG::JAccessible::is_open ( ) const

pure virtualinherited

Check is device is open.

Returns

true if open; else false

Implemented in JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JNullAccess, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootFile, and JROOT::JTreeReaderAccessibleObjectIterator< T >.

open() [1/2]

virtual void JLANG::JAccessible::open ( const char * file_name )

pure virtualinherited

Open device.

Parameters

file_name

file name

Implemented in JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JNullAccess, JLANG::JAccessibleBinaryInputStream, JLANG::JAccessibleBinaryOutputStream, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JRootFileReader< T, false >, JROOT::JRootFileReader< T, true >, JROOT::JRootFileWriter< T >, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileRecorder< T >, JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

close() [1/2]

virtual void JLANG::JAccessible::close ( )

pure virtualinherited

Close device.

Implemented in JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JNullAccess, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

Throw() [1/2]

static void JLANG::JThrow< JAccessible >::Throw ( const bool option )

inlinestaticinherited

Enable/disable throw option.

Parameters

option

true enable; false disable

Definition at line 37 of file JThrow.hh.

Throw() [2/2]

static int JLANG::JThrow< JAccessible >::Throw ( const JException_t & error, const int value = -1 )

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns

return code

Definition at line 51 of file JThrow.hh.

is_open() [2/2]

virtual bool JLANG::JNullAccess::is_open ( ) const

inlineoverridevirtualinherited

Check is device is open.

Returns

true

Implements JLANG::JAccessible.

Definition at line 74 of file JAccessible.hh.

    {
      return true;
    }

open() [2/2]

virtual void JLANG::JNullAccess::open ( const char * file_name )

inlineoverridevirtualinherited

Open device.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Definition at line 85 of file JAccessible.hh.

    {}

close() [2/2]

virtual void JLANG::JNullAccess::close ( )

inlineoverridevirtualinherited

Close device.

Implements JLANG::JAccessible.

Definition at line 92 of file JAccessible.hh.

    {}

hasNext() [2/2]

template<class T >

virtual bool JLANG::JNullIterator< T >::hasNext ( )

inlinevirtualinherited

Check availability of next element.

Returns

false

Implements JLANG::JObjectIterator< T >.

Definition at line 339 of file JObjectIterator.hh.

    {
      return false;
    }

next() [2/2]

template<class T >

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

inlinevirtualinherited

Get next element.

Returns

NULL

Implements JLANG::JObjectIterator< T >.

Definition at line 350 of file JObjectIterator.hh.

    {
      return ps;
    }

Member Data Documentation

do_throw

bool JLANG::JThrow< JAccessible >::do_throw

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

ps

template<class T >

pointer_type JLANG::JNullIterator< T >::ps

privateinherited

Definition at line 356 of file JObjectIterator.hh.

---

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

• JMonteCarloFileReader.hh