JLANG::JGZFileWriter< T > Class Template Reference

Object reading from gzipped file. More...

#include <JGZFileWriter.hh>

Inheritance diagram for JLANG::JGZFileWriter< T >:

Public Member Functions
	JGZFileWriter ()
	Default constructor. More...
	JGZFileWriter (const char *file_name)
	Constructor. More...
	JGZFileWriter (const char *file_name, const std::string &sep)
	Constructor. More...
virtual bool	is_open () const override
	Check is file is open. More...
virtual void	open (const char *file_name) override
	Open file. More...
virtual void	close () override
	Close file. More...
void	open (const char *name, int open_mode=std::ios::out)
gzstreambuf *	rdbuf ()
virtual bool	put (const T &object) override
	Object output. More...
const std::string &	getSeparator () const
	Get token separator. More...
void	setSeparator (const std::string &sep)
	Set token separator. 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

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

Detailed Description

template<class T>
class JLANG::JGZFileWriter< T >

Object reading from gzipped file.

This class implements the JAccessibleObjectIterator interface.

Definition at line 28 of file JGZFileWriter.hh.

Constructor & Destructor Documentation

template<class T >

JLANG::JGZFileWriter< T >::JGZFileWriter ( )

inline

Default constructor.

Definition at line 37 of file JGZFileWriter.hh.

                    :
      ogzstream(),
      JStreamObjectOutput<T>(static_cast<std::ostream&>(*this), "")
    {}

template<class T >

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

inline

Constructor.

Parameters

file_name

file name

Definition at line 48 of file JGZFileWriter.hh.

                                         :
      JAccessible(),
      ogzstream(file_name),
      JStreamObjectOutput<T>(static_cast<std::ostream&>(*this), "")
    {}

template<class T >

JLANG::JGZFileWriter< T >::JGZFileWriter ( const char *  file_name, const std::string &  sep  )

inline

Constructor.

Parameters

file_name	file name
sep	token separator

Definition at line 61 of file JGZFileWriter.hh.

                                        :
      JAccessible(),
      ogzstream(file_name),
      JStreamObjectOutput<T>(static_cast<std::ostream&>(*this), sep)
    {}

Member Function Documentation

template<class T >

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

inlineoverridevirtual

Check is file is open.

Returns

true if open; else false

Implements JLANG::JAccessible.

Definition at line 74 of file JGZFileWriter.hh.

    {
      return ogzstream::is_open();
    }

template<class T >

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

inlineoverridevirtual

Open file.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Definition at line 85 of file JGZFileWriter.hh.

    {
      ogzstream::open(file_name);

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

template<class T >

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

inlineoverridevirtual

Close file.

Implements JLANG::JAccessible.

Definition at line 98 of file JGZFileWriter.hh.

    {
      ogzstream::close();
    }

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

inlineinherited

Definition at line 218 of file gzstream.h.

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

gzstreambuf* gzstreambase::rdbuf ( )

inlineinherited

Definition at line 193 of file gzstream.h.

{ return &buf; }

template<class T>

virtual bool JLANG::JStreamObjectOutput< T >::put ( const T &  object )

inlineoverridevirtualinherited

Object output.

Parameters

object

object

Returns

true if OK; else false

Implements JLANG::JObjectOutput< T >.

Definition at line 51 of file JStreamObjectOutput.hh.

    {
      __out << object << __sep;

      return (bool) __out;
    }

template<class T>

const std::string& JLANG::JStreamObjectOutput< T >::getSeparator ( ) const

inlineinherited

Get token separator.

Returns

separator

Definition at line 64 of file JStreamObjectOutput.hh.

    {
      return this->__sep;
    }

template<class T>

void JLANG::JStreamObjectOutput< T >::setSeparator ( const std::string &  sep )

inlineinherited

Set token separator.

Parameters

sep

separator

Definition at line 75 of file JStreamObjectOutput.hh.

    {
      this->__sep = sep;
    }

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

Member Data Documentation

gzstreambuf gzstreambase::buf

protectedinherited

Definition at line 169 of file gzstream.h.

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:

• JGZFileWriter.hh