JIO::JGZFileStreamWriter Class Reference

Binary buffered file output. More...

#include <JGZFileStreamIO.hh>

Inheritance diagram for JIO::JGZFileStreamWriter:

Public Member Functions
	JGZFileStreamWriter ()
	Default constructor.
	JGZFileStreamWriter (const char *file_name, const int size=1048576)
	Constructor.
void	open (const char *file_name)
	Open file.
void	close ()
	Close file.
bool	operator! () const
	Negated status of this object.
JWriter &	operator<< (const JSerialisable &object)
	Write serialisable data object.
JWriter &	operator<< (const bool value)
JWriter &	operator<< (const char value)
JWriter &	operator<< (const unsigned char value)
JWriter &	operator<< (const short value)
JWriter &	operator<< (const unsigned short value)
JWriter &	operator<< (const int value)
JWriter &	operator<< (const unsigned int value)
JWriter &	operator<< (const long int value)
JWriter &	operator<< (const unsigned long int value)
JWriter &	operator<< (const long long int value)
JWriter &	operator<< (const unsigned long long int value)
JWriter &	operator<< (const float value)
JWriter &	operator<< (const double value)
JWriter &	operator<< (const long double value)
JWriter &	operator<< (const JLANG::JObjectID &value)
JWriter &	operator<< (const JLANG::JStatus &value)
void	open (const char *name, int open_mode=std::ios::out)
gzstreambuf *	rdbuf ()
bool	is_open () const
virtual bool	getStatus () const override
	Status of writer.
virtual int	write (const char *zbuf, int n) override
	Write byte array.
void	flush ()
	Write internal data to output.
JWriter &	store (const JSerialisable &object)
	Write object.
template<class T >
JWriter &	store (const T &object)
	Write object.
	operator bool () const
	Type conversion operator.

Protected Attributes
gzstreambuf	buf
JLANG::JSinglePointer< JWriter >	out
char *	buffer
	internal buffer
int	size
	size of internal buffer
int	pos
	pointer to end of buffered data

Detailed Description

Binary buffered file output.

Definition at line 93 of file JGZFileStreamIO.hh.

Constructor & Destructor Documentation

JGZFileStreamWriter() [1/2]

JIO::JGZFileStreamWriter::JGZFileStreamWriter ( )

inline

Default constructor.

Definition at line 107 of file JGZFileStreamIO.hh.

                          :
      ogzstream(),
      JBufferedWriter(new JStreamWriter(static_cast<ogzstream&>(*this)))
    {}

JGZFileStreamWriter() [2/2]

JIO::JGZFileStreamWriter::JGZFileStreamWriter ( const char * file_name, const int size = 1048576 )

inline

Constructor.

Parameters

file_name	file name
size	size of internal buffer

Definition at line 119 of file JGZFileStreamIO.hh.

                                                    :
      ogzstream(),
      JBufferedWriter(new JStreamWriter(static_cast<ogzstream&>(*this)), size)
    {
      open(file_name);
    }

Member Function Documentation

open() [1/2]

void JIO::JGZFileStreamWriter::open ( const char * file_name )

inline

Open file.

Parameters

file_name

file name

Definition at line 133 of file JGZFileStreamIO.hh.

    {
      static_cast<ogzstream*>(this)->open(file_name, std::ios::out & std::ios::binary);
    }

close()

void JIO::JGZFileStreamWriter::close ( )

inline

Close file.

Definition at line 142 of file JGZFileStreamIO.hh.

    {
      static_cast<JBufferedWriter*>(this)->flush();
      static_cast<ogzstream*>      (this)->close();
    }

operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inline

Negated status of this object.

Returns

negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

    {
      return !(this->getStatus());
    }

operator<<() [1/17]

JWriter & JIO::JWriter::operator<< ( const JSerialisable & object )

inline

Write serialisable data object.

Parameters

object

serialisable data object

Returns

JWriter

Definition at line 146 of file JSerialisable.hh.

    { 
      return object.write(*this); 
    }

operator<<() [2/17]

JWriter & JIO::JWriter::operator<< ( const bool value )

inline

Definition at line 152 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(bool));                   return *this; }

operator<<() [3/17]

JWriter & JIO::JWriter::operator<< ( const char value )

inline

Definition at line 153 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(char));                   return *this; } 

operator<<() [4/17]

JWriter & JIO::JWriter::operator<< ( const unsigned char value )

inline

Definition at line 154 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned char));          return *this; }

operator<<() [5/17]

JWriter & JIO::JWriter::operator<< ( const short value )

inline

Definition at line 155 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(short));                  return *this; }

operator<<() [6/17]

JWriter & JIO::JWriter::operator<< ( const unsigned short value )

inline

Definition at line 156 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned short));         return *this; }

operator<<() [7/17]

JWriter & JIO::JWriter::operator<< ( const int value )

inline

Definition at line 157 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(int));                    return *this; }

operator<<() [8/17]

JWriter & JIO::JWriter::operator<< ( const unsigned int value )

inline

Definition at line 158 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned int));           return *this; }

operator<<() [9/17]

JWriter & JIO::JWriter::operator<< ( const long int value )

inline

Definition at line 159 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long int));               return *this; }

operator<<() [10/17]

JWriter & JIO::JWriter::operator<< ( const unsigned long int value )

inline

Definition at line 160 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned long int));      return *this; }

operator<<() [11/17]

JWriter & JIO::JWriter::operator<< ( const long long int value )

inline

Definition at line 161 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long long int));          return *this; }

operator<<() [12/17]

JWriter & JIO::JWriter::operator<< ( const unsigned long long int value )

inline

Definition at line 162 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned long long int)); return *this; }

operator<<() [13/17]

JWriter & JIO::JWriter::operator<< ( const float value )

inline

Definition at line 163 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(float));                  return *this; }

operator<<() [14/17]

JWriter & JIO::JWriter::operator<< ( const double value )

inline

Definition at line 164 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(double));                 return *this; }

operator<<() [15/17]

JWriter & JIO::JWriter::operator<< ( const long double value )

inline

Definition at line 165 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long double));            return *this; }

operator<<() [16/17]

JWriter & JIO::JWriter::operator<< ( const JLANG::JObjectID & value )

inline

Definition at line 166 of file JSerialisable.hh.

{ return (*this) << value.getID(); }

operator<<() [17/17]

JWriter & JIO::JWriter::operator<< ( const JLANG::JStatus & value )

inline

Definition at line 167 of file JSerialisable.hh.

{ return (*this) << value.getStatus<JLANG::JStatus::status_type>(); }

open() [2/2]

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

rdbuf()

gzstreambuf * gzstreambase::rdbuf ( )

inlineinherited

Definition at line 193 of file gzstream.h.

{ return &buf; }

is_open()

bool gzstreambase::is_open ( ) const

inlineinherited

Definition at line 194 of file gzstream.h.

{ return buf.is_open(); }

getStatus()

virtual bool JIO::JBufferedWriter::getStatus ( ) const

inlineoverridevirtualinherited

Status of writer.

Returns

status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 188 of file JBufferedIO.hh.

    { 
      return (bool) *out;
    }

write()

virtual int JIO::JBufferedWriter::write ( const char * zbuf, int n )

inlineoverridevirtualinherited

Write byte array.

Parameters

zbuf	pointer to byte array
n	number of bytes

Returns

number of bytes

Implements JLANG::JBinaryOutput.

Definition at line 201 of file JBufferedIO.hh.

    { 
      for (int i = 0; i != n; ) {
 
        int m = n - i;
 
        if (m > size - pos) {
 
          flush();
        
          if (m > size - pos) {
            m = size - pos;
          }
        }
 
        memcpy(buffer + pos, zbuf + i, m);
        
        i   += m;
        pos += m;
      }
 
      return n;
    }

flush()

void JIO::JBufferedWriter::flush ( )

inlineinherited

Write internal data to output.

Definition at line 229 of file JBufferedIO.hh.

    {
      pos -= out->write(buffer, pos); 
    }

store() [1/2]

JWriter & JIO::JWriter::store ( const JSerialisable & object )

inlineinherited

Write object.

Parameters

object

object

Returns

this writer

Definition at line 176 of file JSerialisable.hh.

    {
      return object.write(*this);
    }

store() [2/2]

template<class T >

JWriter & JIO::JWriter::store ( const T & object )

inlineinherited

Write object.

Parameters

object

object

Returns

this writer

Definition at line 189 of file JSerialisable.hh.

    {
      return *this << object;
    }

operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns

status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

    {
      return this->getStatus();
    }

Member Data Documentation

buf

gzstreambuf gzstreambase::buf

protectedinherited

Definition at line 169 of file gzstream.h.

out

JLANG::JSinglePointer<JWriter> JIO::JBufferedWriter::out

protectedinherited

Definition at line 236 of file JBufferedIO.hh.

buffer

char* JIO::JBufferedWriter::buffer

protectedinherited

internal buffer

Definition at line 238 of file JBufferedIO.hh.

size

int JIO::JBufferedWriter::size

protectedinherited

size of internal buffer

Definition at line 239 of file JBufferedIO.hh.

pos

int JIO::JBufferedWriter::pos

protectedinherited

pointer to end of buffered data

Definition at line 240 of file JBufferedIO.hh.

---

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

• JGZFileStreamIO.hh