Buffer Class Reference

#include <Buffer.h>

Inheritance diagram for Buffer:

Collaboration diagram for Buffer:

Public Member Functions
	Buffer (const char *inf, const char *outf)
	Buffer (std::string inf, std::string of)
virtual	~Buffer ()
	Destroy the Buffer object insuring that all memory is whiped clean before exiting. More...
void	rotate_left ()
	Rotate the byte rignt by calling the underlying implimentation. More...
void	rotate_right ()
	Rotate the byte left by calling the underlying implementation. More...
virtual void	init ()
	Initialise the Buffer object. More...
virtual uint8_t	get_next_byte ()
	Get the next byte in the stream as a uint8_t. More...
virtual void	write_next_byte (uint8_t byte)
	Write the next byte into the stream. More...
virtual void	write_first_byte (uint8_t byte)
	Write the first byte of the stream, regardless of where we are in the write sequence. More...
virtual unsigned int	get_length ()
virtual bool	end ()
	Test if we have reached the end of the file. More...
Public Member Functions inherited from Base
virtual	~Base ()

Detailed Description

Definition at line 25 of file Buffer.h.

Constructor & Destructor Documentation

Buffer() [1/2]

Buffer	(	const char *	inf,
		const char *	outf
	)

Definition at line 3 of file Buffer.cpp.

Buffer() [2/2]

Buffer	(	std::string	inf,
		std::string	of
	)

Definition at line 8 of file Buffer.cpp.

~Buffer()

~Buffer ( )

virtual

Destroy the Buffer object insuring that all memory is whiped clean before exiting.

Definition at line 18 of file Buffer.cpp.

Member Function Documentation

end()

bool end ( )

virtual

Test if we have reached the end of the file.

Returns

true

false

Implements Base.

Definition at line 91 of file Buffer.cpp.

get_length()

virtual unsigned int get_length ( )

inlinevirtual

Implements Base.

Definition at line 37 of file Buffer.h.

get_next_byte()

uint8_t get_next_byte ( )

virtual

Get the next byte in the stream as a uint8_t.

Returns

uint8_t

Implements Base.

Definition at line 52 of file Buffer.cpp.

init()

void init ( )

virtual

Initialise the Buffer object.

Note

This is a bad bit of architecture that needs rethinking. The idea of init is muduled as it was also used to reset the file point to the start of the file, and this is not really it's function.

Implements Base.

Definition at line 36 of file Buffer.cpp.

Here is the caller graph for this function:

rotate_left()

void rotate_left ( )

virtual

Rotate the byte rignt by calling the underlying implimentation.

Returns

* void

Reimplemented from Base.

Definition at line 101 of file Buffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

rotate_right()

void rotate_right ( )

virtual

Rotate the byte left by calling the underlying implementation.

Reimplemented from Base.

Definition at line 110 of file Buffer.cpp.

Here is the call graph for this function:

write_first_byte()

void write_first_byte ( uint8_t  byte )

virtual

Write the first byte of the stream, regardless of where we are in the write sequence.

Parameters

byte

Implements Base.

Definition at line 78 of file Buffer.cpp.

write_next_byte()

void write_next_byte ( uint8_t  byte )

virtual

Write the next byte into the stream.

Parameters

byte

Implements Base.

Definition at line 66 of file Buffer.cpp.

---

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

• Buffer.h
• Buffer.cpp