Byte array binary input. More...

#include <JByteArrayIO.hh>

Inheritance diagram for JIO::JByteArrayReader:

Public Member Functions
	JByteArrayReader ()
	Default constructor. More...

	JByteArrayReader (const char *buffer, const int length=0)
	Constructor. More...

int	size () const
	Get size. More...

const char *	data () const
	Get data. More...

int	getRemainingSize () const
	Get remaining size. More...

const char *	getRemainingData () const
	Get remaining data. More...

int	tellg () const
	Get read position. More...

void	seekg (const int pos)
	Set read position. More...

virtual bool	getStatus () const
	Status of reader. More...

virtual int	read (char *buffer, const int length)
	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 &	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
const char *	__data

int	__size

int	__pos

Detailed Description

Byte array binary input.

This class implements the JReader interface.

Definition at line 25 of file JByteArrayIO.hh.

Constructor & Destructor Documentation

◆ JByteArrayReader() [1/2]

JIO::JByteArrayReader::JByteArrayReader ( )

inline

Default constructor.

Definition at line 32 of file JByteArrayIO.hh.

                        :
       __data(NULL),
       __size(0),
       __pos (0)
     {}

◆ JByteArrayReader() [2/2]

JIO::JByteArrayReader::JByteArrayReader	(	const char *	buffer,
		const int	length = `0`
	)

inline

Constructor.

Parameters

buffer	pointer to input data
length	number of bytes

Definition at line 45 of file JByteArrayIO.hh.

                                                                :
       __data(buffer),
       __size(length),
       __pos (0)
     {}

Member Function Documentation

◆ size()

int JIO::JByteArrayReader::size ( ) const

inline

Get size.

Returns: number of bytes

Definition at line 57 of file JByteArrayIO.hh.

     {
       return __size;
     }

◆ data()

const char* JIO::JByteArrayReader::data ( ) const

inline

Get data.

Returns: pointer to data

Definition at line 68 of file JByteArrayIO.hh.

     {
       return __data;
     }

◆ getRemainingSize()

int JIO::JByteArrayReader::getRemainingSize ( ) const

inline

Get remaining size.

Returns: number of bytes

Definition at line 79 of file JByteArrayIO.hh.

     {
       return __size - __pos;
     }

◆ getRemainingData()

const char* JIO::JByteArrayReader::getRemainingData ( ) const

inline

Get remaining data.

Returns: pointer to remaining data

Definition at line 90 of file JByteArrayIO.hh.

     {
       return __data + __pos;
     }

◆ tellg()

int JIO::JByteArrayReader::tellg ( ) const

inline

Get read position.

Returns: read position

Definition at line 101 of file JByteArrayIO.hh.

     {
       return __pos;
     }

◆ seekg()

void JIO::JByteArrayReader::seekg ( const int pos )

inline

Set read position.

Parameters

pos	read position

Definition at line 112 of file JByteArrayIO.hh.

     {
       __pos = pos;
     }

◆ getStatus()

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

inlinevirtual

Status of reader.

Returns: status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 123 of file JByteArrayIO.hh.

     { 
       return __size - __pos >= 0; 
     }

◆ read()

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

inlinevirtual

Read byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns: number of bytes

Implements JLANG::JBinaryInput.

Definition at line 136 of file JByteArrayIO.hh.

     { 
       memcpy(buffer, __data + __pos, length);
         
       __pos += length;
  
       return length;
     }

◆ clear()

virtual void JIO::JReader::clear ( )

inlinevirtualinherited

Clear status of reader.

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

Definition at line 70 of file JSerialisable.hh.

71 {}

◆ operator>>() [1/15]

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

inlineinherited

Read serialisable data object.

Parameters

object serialisable data object

Returns: JReader

Definition at line 80 of file JSerialisable.hh.

     { 
       return object.read(*this); 
     }

◆ operator>>() [2/15]

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

inlineinherited

Definition at line 86 of file JSerialisable.hh.

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

◆ operator>>() [3/15]

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

inlineinherited

Definition at line 87 of file JSerialisable.hh.

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

◆ operator>>() [4/15]

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

inlineinherited

Definition at line 88 of file JSerialisable.hh.

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

◆ operator>>() [5/15]

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

inlineinherited

Definition at line 89 of file JSerialisable.hh.

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

◆ operator>>() [6/15]

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

inlineinherited

Definition at line 90 of file JSerialisable.hh.

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

◆ operator>>() [7/15]

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

inlineinherited

Definition at line 91 of file JSerialisable.hh.

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

◆ operator>>() [8/15]

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

inlineinherited

Definition at line 92 of file JSerialisable.hh.

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

◆ operator>>() [9/15]

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

inlineinherited

Definition at line 93 of file JSerialisable.hh.

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

◆ operator>>() [10/15]

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

inlineinherited

Definition at line 94 of file JSerialisable.hh.

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

◆ operator>>() [11/15]

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

inlineinherited

Definition at line 95 of file JSerialisable.hh.

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

◆ operator>>() [12/15]

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

inlineinherited

Definition at line 96 of file JSerialisable.hh.

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

◆ operator>>() [13/15]

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

inlineinherited

Definition at line 97 of file JSerialisable.hh.

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

◆ operator>>() [14/15]

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

inlineinherited

Definition at line 98 of file JSerialisable.hh.

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

◆ operator>>() [15/15]

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

inlineinherited

Definition at line 99 of file JSerialisable.hh.

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

◆ load() [1/2]

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

inlineinherited

Read object.

Parameters

object object

Returns: this reader

Definition at line 108 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 121 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

◆ __data

const char* JIO::JByteArrayReader::__data

protected

Definition at line 147 of file JByteArrayIO.hh.

◆ __size

int JIO::JByteArrayReader::__size

protected

Definition at line 148 of file JByteArrayIO.hh.

◆ __pos

int JIO::JByteArrayReader::__pos

protected

Definition at line 149 of file JByteArrayIO.hh.

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

JByteArrayIO.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JByteArrayReader() [1/2]

◆ JByteArrayReader() [2/2]

Member Function Documentation

◆ size()

◆ data()

◆ getRemainingSize()

◆ getRemainingData()

◆ tellg()

◆ seekg()

◆ getStatus()

◆ read()

◆ clear()

◆ operator>>() [1/15]

◆ operator>>() [2/15]

◆ operator>>() [3/15]

◆ operator>>() [4/15]

◆ operator>>() [5/15]

◆ operator>>() [6/15]

◆ operator>>() [7/15]

◆ operator>>() [8/15]

◆ operator>>() [9/15]

◆ operator>>() [10/15]

◆ operator>>() [11/15]

◆ operator>>() [12/15]

◆ operator>>() [13/15]

◆ operator>>() [14/15]

◆ operator>>() [15/15]

◆ load() [1/2]

◆ load() [2/2]

◆ operator bool()

◆ operator!()

Member Data Documentation

◆ __data

◆ __size

◆ __pos