JIO::JBufferedReader Class Reference

Buffered binary input. More...

#include <JBufferedIO.hh>

Inheritance diagram for JIO::JBufferedReader:

Public Member Functions
	JBufferedReader (JReader *__in, const int __size=1048576)
	Constructor.
	~JBufferedReader ()
	Destructor.
virtual bool	getStatus () const override
	Status of reader.
virtual void	clear () override
	Clear status of reader.
virtual int	read (char *zbuf, int n) override
	Read byte array.
JReader &	operator>> (JSerialisable &object)
	Read serialisable data object.
JReader &	operator>> (bool &value)
JReader &	operator>> (char &value)
JReader &	operator>> (unsigned char &value)
JReader &	operator>> (short &value)
JReader &	operator>> (unsigned short &value)
JReader &	operator>> (int &value)
JReader &	operator>> (unsigned int &value)
JReader &	operator>> (long int &value)
JReader &	operator>> (unsigned long int &value)
JReader &	operator>> (long long int &value)
JReader &	operator>> (unsigned long long int &value)
JReader &	operator>> (float &value)
JReader &	operator>> (double &value)
JReader &	operator>> (long double &value)
JReader &	operator>> (JLANG::JObjectID &value)
JReader &	operator>> (JLANG::JStatus &value)
JReader &	load (JSerialisable &object)
	Read object.
template<class T >
JReader &	load (T &object)
	Read object.
	operator bool () const
	Type conversion operator.
bool	operator! () const
	Negated status of this object.

Protected Member Functions
void	reset ()
	Reset.

Protected Attributes
JLANG::JSinglePointer< JReader >	in
char *	buffer
	internal buffer
int	size
	size of internal buffer
int	pos
	pointer to begin of available data
int	ls
	pointer to end of available data
bool	eof
	end of file

Private Member Functions
	JBufferedReader (const JBufferedReader &)
	JBufferedReader (JBufferedReader &&)
JBufferedReader &	operator= (const JBufferedReader &)
JBufferedReader &	operator= (JBufferedReader &&)

Detailed Description

Buffered binary input.

This class implements the JReader interface.

Definition at line 25 of file JBufferedIO.hh.

Constructor & Destructor Documentation

JBufferedReader() [1/3]

JIO::JBufferedReader::JBufferedReader ( JReader * __in, const int __size = 1048576 )

inline

Constructor.

Note that this object owns the reader pointed to.

Parameters

__in	pointer to reader
__size	size of internal buffer

Definition at line 36 of file JBufferedIO.hh.

                                                               :
      in(__in)
    {
      size   = std::max(__size, 1024);
      buffer = new char[size];
 
      reset();
    }

~JBufferedReader()

JIO::JBufferedReader::~JBufferedReader ( )

inline

Destructor.

Definition at line 49 of file JBufferedIO.hh.

    {
      delete [] buffer;
    }

JBufferedReader() [2/3]

JIO::JBufferedReader::JBufferedReader ( const JBufferedReader & )

private

JBufferedReader() [3/3]

JIO::JBufferedReader::JBufferedReader ( JBufferedReader && )

private

Member Function Documentation

getStatus()

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

inlineoverridevirtual

Status of reader.

Returns

status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 60 of file JBufferedIO.hh.

    { 
      return in->getStatus() || !eof;
    }

clear()

virtual void JIO::JBufferedReader::clear ( )

inlineoverridevirtual

Clear status of reader.

Reimplemented from JIO::JReader.

Reimplemented in JIO::JFileStreamReader, and JIO::JGZFileStreamReader.

Definition at line 69 of file JBufferedIO.hh.

    {
      in->clear();
    }

read()

virtual int JIO::JBufferedReader::read ( char * zbuf, int n )

inlineoverridevirtual

Read byte array.

Parameters

zbuf	pointer to byte array
n	number of bytes

Returns

number of bytes

Implements JLANG::JBinaryInput.

Definition at line 82 of file JBufferedIO.hh.

    { 
      for (int i = 0; i != n; ) {
 
        int m = n - i;
 
        if (m > ls - pos) {
          
          memmove(buffer, buffer + pos, ls - pos);
          
          ls  -= pos;
          pos  = 0;
          ls  += in->read(buffer + ls, size - ls); 
 
          if (m > ls) {
 
            if (ls == 0) {
 
              eof = true;
 
              return n - i;
            }
 
            m = ls;
          }
        }
 
        memcpy(zbuf + i, buffer + pos, m);
        
        i   += m;
        pos += m;
      }
 
      eof = false;
 
      return n;
    }

reset()

void JIO::JBufferedReader::reset ( )

inlineprotected

Reset.

Definition at line 124 of file JBufferedIO.hh.

    {
      pos = 0;
      ls  = 0;
      eof = true;
    }

operator=() [1/2]

JBufferedReader & JIO::JBufferedReader::operator= ( const JBufferedReader & )

private

operator=() [2/2]

JBufferedReader & JIO::JBufferedReader::operator= ( JBufferedReader && )

private

operator>>() [1/17]

JReader & JIO::JReader::operator>> ( JSerialisable & object )

inlineinherited

Read serialisable data object.

Parameters

object

serialisable data object

Returns

JReader

Definition at line 82 of file JSerialisable.hh.

    { 
      return object.read(*this); 
    }

operator>>() [2/17]

JReader & JIO::JReader::operator>> ( bool & value )

inlineinherited

Definition at line 88 of file JSerialisable.hh.

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

operator>>() [3/17]

JReader & JIO::JReader::operator>> ( char & value )

inlineinherited

Definition at line 89 of file JSerialisable.hh.

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

operator>>() [4/17]

JReader & JIO::JReader::operator>> ( unsigned char & value )

inlineinherited

Definition at line 90 of file JSerialisable.hh.

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

operator>>() [5/17]

JReader & JIO::JReader::operator>> ( short & value )

inlineinherited

Definition at line 91 of file JSerialisable.hh.

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

operator>>() [6/17]

JReader & JIO::JReader::operator>> ( unsigned short & value )

inlineinherited

Definition at line 92 of file JSerialisable.hh.

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

operator>>() [7/17]

JReader & JIO::JReader::operator>> ( int & value )

inlineinherited

Definition at line 93 of file JSerialisable.hh.

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

operator>>() [8/17]

JReader & JIO::JReader::operator>> ( unsigned int & value )

inlineinherited

Definition at line 94 of file JSerialisable.hh.

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

operator>>() [9/17]

JReader & JIO::JReader::operator>> ( long int & value )

inlineinherited

Definition at line 95 of file JSerialisable.hh.

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

operator>>() [10/17]

JReader & JIO::JReader::operator>> ( unsigned long int & value )

inlineinherited

Definition at line 96 of file JSerialisable.hh.

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

operator>>() [11/17]

JReader & JIO::JReader::operator>> ( long long int & value )

inlineinherited

Definition at line 97 of file JSerialisable.hh.

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

operator>>() [12/17]

JReader & JIO::JReader::operator>> ( unsigned long long int & value )

inlineinherited

Definition at line 98 of file JSerialisable.hh.

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

operator>>() [13/17]

JReader & JIO::JReader::operator>> ( float & value )

inlineinherited

Definition at line 99 of file JSerialisable.hh.

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

operator>>() [14/17]

JReader & JIO::JReader::operator>> ( double & value )

inlineinherited

Definition at line 100 of file JSerialisable.hh.

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

operator>>() [15/17]

JReader & JIO::JReader::operator>> ( long double & value )

inlineinherited

Definition at line 101 of file JSerialisable.hh.

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

operator>>() [16/17]

JReader & JIO::JReader::operator>> ( JLANG::JObjectID & value )

inlineinherited

Definition at line 102 of file JSerialisable.hh.

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

operator>>() [17/17]

JReader & JIO::JReader::operator>> ( JLANG::JStatus & value )

inlineinherited

Definition at line 103 of file JSerialisable.hh.

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

load() [1/2]

JReader & JIO::JReader::load ( JSerialisable & object )

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 112 of file JSerialisable.hh.

    {
      return object.read(*this);
    }

load() [2/2]

template<class T >

JReader & JIO::JReader::load ( T & object )

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 125 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();
    }

operator!()

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

inlineinherited

Negated status of this object.

Returns

negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

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

Member Data Documentation

in

JLANG::JSinglePointer<JReader> JIO::JBufferedReader::in

protected

Definition at line 131 of file JBufferedIO.hh.

buffer

char* JIO::JBufferedReader::buffer

protected

internal buffer

Definition at line 133 of file JBufferedIO.hh.

size

int JIO::JBufferedReader::size

protected

size of internal buffer

Definition at line 134 of file JBufferedIO.hh.

pos

int JIO::JBufferedReader::pos

protected

pointer to begin of available data

Definition at line 135 of file JBufferedIO.hh.

ls

int JIO::JBufferedReader::ls

protected

pointer to end of available data

Definition at line 136 of file JBufferedIO.hh.

eof

bool JIO::JBufferedReader::eof

protected

end of file

Definition at line 137 of file JBufferedIO.hh.

---

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

• JBufferedIO.hh