Object reading from gzipped file. More...

#include <JGZFileReader.hh>

Inheritance diagram for JLANG::JGZFileReader< T >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JGZFileReader ()
	Default constructor. More...

	JGZFileReader (const char *file_name)
	Constructor. More...

virtual bool	is_open () const
	Check is file is open. More...

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

virtual void	close ()
	Close file. More...

void	open (const char *name, int open_mode=std::ios::in)

gzstreambuf *	rdbuf ()

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

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

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

virtual skip_type	skip (const skip_type ns)
	Skip items. 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...

Protected Attributes
gzstreambuf	buf

std::istream &	__in

T	object
	object More...

bool	has_next
	status More...

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

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
class JLANG::JGZFileReader< T >

Object reading from gzipped file.

This class implements the JAccessibleObjectIterator interface.

Definition at line 28 of file JGZFileReader.hh.

Member Typedef Documentation

◆ pointer_type

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

◆ JGZFileReader() [1/2]

template<class T >

JLANG::JGZFileReader< T >::JGZFileReader ( )

inline

Default constructor.

Definition at line 37 of file JGZFileReader.hh.

                     :
       igzstream(),
       JStreamObjectIterator<T>(static_cast<std::istream&>(*this))
     {}

◆ JGZFileReader() [2/2]

template<class T >

JLANG::JGZFileReader< T >::JGZFileReader ( const char * file_name )

inline

Constructor.

Parameters

file_name file name

Definition at line 48 of file JGZFileReader.hh.

                                          :
       JAccessible(),
       igzstream(file_name),
       JStreamObjectIterator<T>(static_cast<std::istream&>(*this))
     {}

Member Function Documentation

◆ is_open()

template<class T >

virtual bool JLANG::JGZFileReader< T >::is_open ( ) const

inlinevirtual

Check is file is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 60 of file JGZFileReader.hh.

     {
       return igzstream::is_open();
     }

◆ open() [1/2]

template<class T >

virtual void JLANG::JGZFileReader< T >::open ( const char * file_name )

inlinevirtual

Open file.

Parameters

file_name file name

Implements JLANG::JAccessible.

Definition at line 71 of file JGZFileReader.hh.

     {
       igzstream::open(file_name);
  
       if (!this->is_open()) {
         this->Throw(JFileOpenException(std::string("Error opening file ") + file_name));
       }
     }

◆ close()

template<class T >

virtual void JLANG::JGZFileReader< T >::close ( )

inlinevirtual

Close file.

Implements JLANG::JAccessible.

Definition at line 84 of file JGZFileReader.hh.

     {
       igzstream::close();
     }

◆ open() [2/2]

void igzstream::open	(	const char *	name,
		int	open_mode = `std::ios::in`
	)

inlineinherited

Definition at line 208 of file gzstream.h.

                                                            {
         gzstreambase::open( name, open_mode);
     }

◆ rdbuf()

gzstreambuf* gzstreambase::rdbuf ( )

inlineinherited

Definition at line 193 of file gzstream.h.

193 { return &buf; }

◆ setObject()

template<class T >

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

inlinevirtualinherited

Set object.

Parameters

object reference to object to be set

Returns: true if set; else false

Implements JLANG::JAbstractObjectIterator< T >.

Definition at line 45 of file JStreamObjectIterator.hh.

     {
       return (bool) (__in && __in >> object);
     }

◆ hasNext()

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.

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

◆ next()

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.

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

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

Definition at line 88 of file JObjectIterator.hh.

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

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

     {
       do_throw = option;
     }

◆ Throw() [2/2]

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

Member Data Documentation

◆ buf

gzstreambuf gzstreambase::buf

protectedinherited

Definition at line 169 of file gzstream.h.

◆ __in

template<class T >

std::istream& JLANG::JStreamObjectIterator< T >::__in

protectedinherited

Definition at line 51 of file JStreamObjectIterator.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.

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

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

JGZFileReader.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

template<class T> class JLANG::JGZFileReader< T >

Member Typedef Documentation

◆ pointer_type

Constructor & Destructor Documentation

◆ JGZFileReader() [1/2]

◆ JGZFileReader() [2/2]

Member Function Documentation

◆ is_open()

◆ open() [1/2]

◆ close()

◆ open() [2/2]

◆ rdbuf()

◆ setObject()

◆ hasNext()

◆ next()

◆ skip()

◆ Throw() [1/2]

◆ Throw() [2/2]

Member Data Documentation

◆ buf

◆ __in

◆ object

◆ has_next

◆ ps

◆ do_throw

template<class T>
class JLANG::JGZFileReader< T >