BlockBuffer Class Reference

Deals with the loading and saving of blocks for coding. More...

#include <BlockBuffer.h>

Inheritance diagram for BlockBuffer:
Decode< T > Decode< TRIPLET > Encode< T > EncodeDouble< T >

List of all members.

Public Member Functions

 BlockBuffer (int bufferSize)
 Create the buffer of size bufferSize.
char * bufferPtr (void)
 Return the pointer to the buffer begin used.
long bufferSize (void)
 Return the size of the current buffer.
bool bufferFull (void)
 True if we have scanned all of the buffer.
bool bufferOverflow (void)
 True if we have scanned past the end of the buffer.
void padBuffer (void)
 Fill the remainder of the buffer with zeros.
void initialise (void)
 Set buffer scanner to the beginning.
void truncateToNextBlock (int blockSize)
 Reduce the buffer size to a integral block size.
void encodeInt (int element)
 Insert an integer at the current bit position.
int decodeInt (void)
 Read interger at the current bit position.
long bufferByteAlign (int blockBytes)
 Return the number of bytes + blockBytes used.
virtual void flushBuffer (void)=0
 Reset the buffer.

Protected Attributes

const int _bufferSize
 The buffer size.
char * _buffer
 The buffer pointer.
char * _bufferPosition
 The current buffer position.
char * _endBuffer
 The end of the buffer.

Detailed Description

Deals with the loading and saving of blocks for coding.

This class controls the contents of the buffer used when encoding or decoding data to and from files. The blockBuffer provides the functions to control the contents of the buffer that is used during compression.

Author
lapark
Revision
1.4
Date
2009/10/08 06:41:29
Id
BlockBuffer.h,v 1.4 2009/10/08 06:41:29 lapark Exp

The documentation for this class was generated from the following files:
 All Classes Functions Variables Friends

Generated on Tue Nov 10 14:12:09 2009 for textIR by  doxygen 1.6.1