JLANG::JGZFileReader< T > Class Template Reference

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.
	JGZFileReader (const char *file_name)
	Constructor.
virtual bool	is_open () const override
	Check is file is open.
virtual void	open (const char *file_name) override
	Open file.
virtual void	close () override
	Close file.
void	open (const char *name, int open_mode=std::ios::in)
gzstreambuf *	rdbuf ()
virtual bool	setObject (T &object) override
	Set object.
virtual bool	hasNext () override
	Check availability of next element.
virtual const pointer_type &	next () override
	Get next element.
virtual skip_type	skip (const skip_type ns)
	Skip items.

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.

Protected Attributes
gzstreambuf	buf
std::istream &	__in
T	object
	object
bool	has_next
	status

Static Protected Attributes
static bool	do_throw
	throw option

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 >

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

inlineoverridevirtual

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 )

inlineoverridevirtual

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 ( )

inlineoverridevirtual

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.

{ return &buf; }

setObject()

template<class T >

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

inlineoverridevirtualinherited

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 ( )

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()

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

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< Evt >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< Evt >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JTypeList< JHead_t, JTail_t > >, and JSUPPORT::JSingleFileScanner<>.

Definition at line 90 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_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.

    {
      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