JIO::JFileStreamReader Class Reference

Binary buffered file input. More...

#include <JFileStreamIO.hh>

Inheritance diagram for JIO::JFileStreamReader:

Public Member Functions
	JFileStreamReader ()
	Default constructor. More...
	JFileStreamReader (const char *file_name, const int size=1048576)
	Constructor. More...
void	open (const char *file_name)
	Open file. More...
virtual void	clear () override
	Clear status of reader. More...
void	rewind ()
	Rewind. More...
bool	operator! () const
	Negated status of this object. More...
JReader &	operator>> (JSerialisable &object)
	Read serialisable data object. More...
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)
virtual bool	getStatus () const override
	Status of reader. More...
virtual int	read (char *zbuf, int n) override
	Read byte array. More...
JReader &	operator>> (JSerialisable &object)
	Read serialisable data object. More...
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 &	load (JSerialisable &object)
	Read object. More...
template<class T >
JReader &	load (T &object)
	Read object. More...
	operator bool () const
	Type conversion operator. More...
bool	operator! () const
	Negated status of this object. More...

Protected Member Functions
void	reset ()
	Reset. More...

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

Detailed Description

Binary buffered file input.

Definition at line 22 of file JFileStreamIO.hh.

Constructor & Destructor Documentation

JFileStreamReader() [1/2]

JIO::JFileStreamReader::JFileStreamReader ( )

inline

Default constructor.

Definition at line 36 of file JFileStreamIO.hh.

                        :
      std::ifstream(),
      JBufferedReader(new JStreamReader(static_cast<std::ifstream&>(*this)))
    {}

JFileStreamReader() [2/2]

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

inline

Constructor.

Parameters

file_name	file name
size	size of internal buffer

Definition at line 48 of file JFileStreamIO.hh.

                                                  :
      std::ifstream  (),
      JBufferedReader(new JStreamReader(static_cast<std::ifstream&>(*this)), size)
    {
      open(file_name);
    }

Member Function Documentation

open()

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

inline

Open file.

Parameters

file_name

file name

Definition at line 62 of file JFileStreamIO.hh.

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

clear()

virtual void JIO::JFileStreamReader::clear ( )

inlineoverridevirtual

Clear status of reader.

Reimplemented from JIO::JBufferedReader.

Definition at line 71 of file JFileStreamIO.hh.

    {
      std::ifstream  ::clear();
      JBufferedReader::clear();
    }

rewind()

void JIO::JFileStreamReader::rewind ( )

inline

Rewind.

Definition at line 81 of file JFileStreamIO.hh.

    {
      seekg(0);   // rewind file stream
 
      reset();    // reset buffer
    }

operator!() [1/2]

bool JLANG::JAbstractObjectStatus::operator!

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/32]

JReader& JIO::JReader::operator>>

inline

Read serialisable data object.

Parameters

object

serialisable data object

Returns

JReader

Definition at line 81 of file JSerialisable.hh.

    { 
      return object.read(*this); 
    }

operator>>() [2/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 87 of file JSerialisable.hh.

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

operator>>() [3/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 88 of file JSerialisable.hh.

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

operator>>() [4/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 89 of file JSerialisable.hh.

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

operator>>() [5/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 90 of file JSerialisable.hh.

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

operator>>() [6/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 91 of file JSerialisable.hh.

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

operator>>() [7/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 92 of file JSerialisable.hh.

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

operator>>() [8/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 93 of file JSerialisable.hh.

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

operator>>() [9/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 94 of file JSerialisable.hh.

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

operator>>() [10/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 95 of file JSerialisable.hh.

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

operator>>() [11/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 96 of file JSerialisable.hh.

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

operator>>() [12/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 97 of file JSerialisable.hh.

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

operator>>() [13/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 98 of file JSerialisable.hh.

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

operator>>() [14/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 99 of file JSerialisable.hh.

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

operator>>() [15/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 100 of file JSerialisable.hh.

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

operator>>() [16/32]

JReader& JIO::JReader::operator>>

inline

Definition at line 101 of file JSerialisable.hh.

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

getStatus()

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

inlineoverridevirtualinherited

Status of reader.

Returns

status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 60 of file JBufferedIO.hh.

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

read()

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

inlineoverridevirtualinherited

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

inlineprotectedinherited

Reset.

Definition at line 124 of file JBufferedIO.hh.

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

operator>>() [17/32]

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

inlineinherited

Read serialisable data object.

Parameters

object

serialisable data object

Returns

JReader

Definition at line 81 of file JSerialisable.hh.

    { 
      return object.read(*this); 
    }

operator>>() [18/32]

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

inlineinherited

Definition at line 87 of file JSerialisable.hh.

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

operator>>() [19/32]

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

inlineinherited

Definition at line 88 of file JSerialisable.hh.

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

operator>>() [20/32]

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

inlineinherited

Definition at line 89 of file JSerialisable.hh.

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

operator>>() [21/32]

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

inlineinherited

Definition at line 90 of file JSerialisable.hh.

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

operator>>() [22/32]

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

inlineinherited

Definition at line 91 of file JSerialisable.hh.

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

operator>>() [23/32]

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

inlineinherited

Definition at line 92 of file JSerialisable.hh.

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

operator>>() [24/32]

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

inlineinherited

Definition at line 93 of file JSerialisable.hh.

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

operator>>() [25/32]

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

inlineinherited

Definition at line 94 of file JSerialisable.hh.

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

operator>>() [26/32]

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

inlineinherited

Definition at line 95 of file JSerialisable.hh.

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

operator>>() [27/32]

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

inlineinherited

Definition at line 96 of file JSerialisable.hh.

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

operator>>() [28/32]

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

inlineinherited

Definition at line 97 of file JSerialisable.hh.

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

operator>>() [29/32]

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

inlineinherited

Definition at line 98 of file JSerialisable.hh.

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

operator>>() [30/32]

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

inlineinherited

Definition at line 99 of file JSerialisable.hh.

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

operator>>() [31/32]

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

inlineinherited

Definition at line 100 of file JSerialisable.hh.

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

operator>>() [32/32]

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

inlineinherited

Definition at line 101 of file JSerialisable.hh.

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

load() [1/2]

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

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 110 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 123 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!() [2/2]

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

protectedinherited

Definition at line 131 of file JBufferedIO.hh.

buffer

char* JIO::JBufferedReader::buffer

protectedinherited

internal buffer

Definition at line 133 of file JBufferedIO.hh.

size

int JIO::JBufferedReader::size

protectedinherited

size of internal buffer

Definition at line 134 of file JBufferedIO.hh.

pos

int JIO::JBufferedReader::pos

protectedinherited

pointer to begin of available data

Definition at line 135 of file JBufferedIO.hh.

ls

int JIO::JBufferedReader::ls

protectedinherited

pointer to end of available data

Definition at line 136 of file JBufferedIO.hh.

eof

bool JIO::JBufferedReader::eof

protectedinherited

end of file

Definition at line 137 of file JBufferedIO.hh.

---

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

• JFileStreamIO.hh