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

typedef JObjectIterator< T > ::pointer_type	pointer_type

Public Member Functions
virtual bool	hasNext ()=0
	Check availability of next element. More...

virtual const pointer_type &	next ()=0
	Get next element. More...

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

virtual bool	is_open () const =0
	Check is device is open. More...

virtual void	open (const char *file_name)=0
	Open device. More...

virtual void	close ()=0
	Close device. More...

virtual bool	is_open () const override
	Check is device is open. More...

virtual void	open (const char *file_name) override
	Open device. More...

virtual void	close () override
	Close device. More...

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

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

Static Public Member Functions
static void	Throw (const bool option)
	Enable/disable throw option. More...

static int	Throw (const JException &error, const int value=-1)
	Throw exception or return error. More...

Static Protected Attributes
static bool	do_throw
	throw option More...

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

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.

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

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

template<class T>

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

pure virtualinherited

Get next element.

Returns: pointer to element

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

Definition at line 90 of file JObjectIterator.hh.

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

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

pure virtualinherited

Check is device is open.

Returns: true if open; else false

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

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

pure virtualinherited

Open device.

Parameters

file_name file name

virtual void JLANG::JAccessible::close ( )

pure virtualinherited

Close device.

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

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.

     {
       do_throw = option;
     }

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

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns: return code

Definition at line 50 of file JThrow.hh.

     {
       using namespace std;
       
       if (do_throw) {
         throw error;
       }
 
       cerr << error.what() << endl;
       
       return value;
     }

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

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.

86 {}

virtual void JLANG::JNullAccess::close ( )

inlineoverridevirtualinherited

Close device.

Implements JLANG::JAccessible.

Definition at line 92 of file JAccessible.hh.

93 {}

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

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

bool JLANG::JThrow< JAccessible >::do_throw

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

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

JMonteCarloFileReader.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Detailed Description

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

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

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