InBinary Class Reference

#include <InStreams.h>

Inheritance diagram for InBinary:

StreamReader InStream< InFile, InBinary > InStream< InMemory, InBinary > InStream< InMessageQueue, InBinary > InBinaryFile InBinaryMemory InBinaryMessage List of all members.

Protected Member Functions

virtual bool isEof (const PhysicalInStream &stream) const
virtual void readChar (char &d, PhysicalInStream &stream)
virtual void readUChar (unsigned char &d, PhysicalInStream &stream)
virtual void readShort (short &d, PhysicalInStream &stream)
virtual void readUShort (unsigned short &d, PhysicalInStream &stream)
virtual void readInt (int &d, PhysicalInStream &stream)
virtual void readUInt (unsigned int &d, PhysicalInStream &stream)
virtual void readLong (long &d, PhysicalInStream &stream)
virtual void readULong (unsigned long &d, PhysicalInStream &stream)
virtual void readFloat (float &d, PhysicalInStream &stream)
virtual void readDouble (double &d, PhysicalInStream &stream)
virtual void readString (char *d, PhysicalInStream &stream)
virtual void readEndl (PhysicalInStream &stream)
virtual void readData (void *p, int size, PhysicalInStream &stream)
virtual void skipData (int size, PhysicalInStream &stream)

Detailed Description

Formated reading of binary data to be used in streams. The physical reading is done by PhysicalInStream derivates.

Definition at line 522 of file InStreams.h.


Member Function Documentation

virtual bool InBinary::isEof ( const PhysicalInStream stream  )  const [inline, protected, virtual]

The function returns whether the end of stream has been reached.

Returns:
End of stream reached?

Implements StreamReader.

Definition at line 529 of file InStreams.h.

References PhysicalInStream::getEof().

virtual void InBinary::readChar ( char &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a char from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 536 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readData ( void *  p,
int  size,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a number of bytes from a stream.

Parameters:
p The address the data is written to. Note that p must point to a memory area that is at least "size" bytes large.
size The number of bytes to be read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 636 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readDouble ( double &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a double from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 608 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readEndl ( PhysicalInStream stream  )  [inline, protected, virtual]

The function is intended to read an endl-symbol from the stream. In fact, the function does nothing.

Parameters:
stream A Stream to read from.

Implements StreamReader.

Definition at line 626 of file InStreams.h.

virtual void InBinary::readFloat ( float &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a float from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 600 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readInt ( int &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads an int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 568 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readLong ( long &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a long int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 584 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readShort ( short &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a short int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 552 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readString ( char *  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads a string from the stream.

Parameters:
d The value that is read. Note that d must point to a memory area that is large enough to carry the string.
stream A Stream to read from.

Implements StreamReader.

Definition at line 618 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readUChar ( unsigned char &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads an unsigned char from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 544 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readUInt ( unsigned int &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads an unsigned int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 576 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readULong ( unsigned long &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads an unsigned long int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 592 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::readUShort ( unsigned short &  d,
PhysicalInStream stream 
) [inline, protected, virtual]

The function reads an unsigned short int from the stream.

Parameters:
d The value that is read.
stream A Stream to read from.

Implements StreamReader.

Definition at line 560 of file InStreams.h.

References PhysicalInStream::readFromStream().

virtual void InBinary::skipData ( int  size,
PhysicalInStream stream 
) [inline, protected, virtual]

The function skips a number of bytes in the file.

Parameters:
size The number of bytes to be skipped.
stream The stream to read from.

Reimplemented from StreamReader.

Definition at line 644 of file InStreams.h.

References PhysicalInStream::skipInStream().


The documentation for this class was generated from the following file:
Generated on Thu Dec 7 01:38:22 2006 for DT2005.panorama by  doxygen 1.4.7