JIO::JFileReader Class Reference

Binary input based on a file descriptor. More...

#include <JFileIO.hh>

Inheritance diagram for JIO::JFileReader:

Public Member Functions
	JFileReader (const JFile &file)
	Constructor. More...
virtual bool	getStatus () const override
	Status of reader. More...
virtual int	read (char *buffer, const int length) override
	Read byte array. More...
virtual void	clear ()
	Clear status of reader. 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 Attributes
JFile	in

Detailed Description

Binary input based on a file descriptor.

This class implements the JReader interface.

Definition at line 26 of file JFileIO.hh.

Constructor & Destructor Documentation

JIO::JFileReader::JFileReader ( const JFile &  file )

inline

Constructor.

Parameters

file

file

Definition at line 35 of file JFileIO.hh.

                                   :
      in(file)
    {}

Member Function Documentation

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

inlineoverridevirtual

Status of reader.

Returns

status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 45 of file JFileIO.hh.

    {
      return in.good();
    }

virtual int JIO::JFileReader::read ( char *  buffer, const int  length  )

inlineoverridevirtual

Read byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns

number of bytes read

Implements JLANG::JBinaryInput.

Definition at line 58 of file JFileIO.hh.

    { 
      return in.read(buffer, length);
    }

virtual void JIO::JReader::clear ( )

inlinevirtualinherited

Clear status of reader.

Reimplemented in JIO::JFileStreamReader, JIO::JBufferedReader, and JIO::JStreamReader.

Definition at line 71 of file JSerialisable.hh.

    {}

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

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

inlineinherited

Definition at line 87 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 88 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 89 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 90 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 91 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 92 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 93 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 94 of file JSerialisable.hh.

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

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

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

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

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

inlineinherited

Definition at line 98 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 99 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 100 of file JSerialisable.hh.

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

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

inlineinherited

Definition at line 101 of file JSerialisable.hh.

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

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

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

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

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

JFile JIO::JFileReader::in

protected

Definition at line 64 of file JFileIO.hh.

---

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

• JFileIO.hh