Buffer Class Reference

#include <buffer.h>

List of all members.

Public Member Functions
	Buffer ()
void	push (char c)
void	pop ()
void	clear ()
bool	empty ()
char *	front ()
int	size ()
unsigned char	read ()
	Buffer ()
void	push (char c)
void	pop ()
void	clear ()
bool	empty ()
char *	front ()
int	size ()
unsigned char	read ()
	Buffer ()
void	push (char c)
void	pop ()
void	clear ()
bool	empty ()
char *	front ()
int	size ()
unsigned char	read ()
	Buffer ()
void	push (char c)
void	pop ()
void	clear ()
bool	empty ()
char *	front ()
int	size ()
unsigned char	read ()
Public Attributes
int	_size
BufferItem *	_head
BufferItem *	_tail

---

Detailed Description

FIFO Buffer class

Stores incomming USART characters

Definition at line 47 of file buffer.h.

---

Constructor & Destructor Documentation

Buffer::Buffer

(

)

Default constructor

Definition at line 27 of file buffer.cpp.

Buffer::Buffer

(

)

Default constructor

Buffer::Buffer

(

)

Default constructor

Buffer::Buffer

(

)

Default constructor

---

Member Function Documentation

void Buffer::clear

(

)

Clears buffer - removes all items

Definition at line 32 of file buffer.cpp.

void Buffer::clear

(

)

Clears buffer - removes all items

void Buffer::clear

(

)

Clears buffer - removes all items

void Buffer::clear

(

)

Clears buffer - removes all items

bool Buffer::empty

(

)

Checks if buffer is empty

Returns:

true if there are items in buffer, otherwise false

bool Buffer::empty

(

)

Checks if buffer is empty

Returns:

true if there are items in buffer, otherwise false

Definition at line 36 of file buffer.cpp.

bool Buffer::empty

(

)

Checks if buffer is empty

Returns:

true if there are items in buffer, otherwise false

bool Buffer::empty

(

)

Checks if buffer is empty

Returns:

true if there are items in buffer, otherwise false

char* Buffer::front

(

)

Returns pointer to first item

Returns:

pointer to first item

See also:

read()

char * Buffer::front

(

)

Returns pointer to first item

Returns:

pointer to first item

See also:

read()

Definition at line 59 of file buffer.cpp.

char* Buffer::front

(

)

Returns pointer to first item

Returns:

pointer to first item

See also:

read()

char* Buffer::front

(

)

Returns pointer to first item

Returns:

pointer to first item

See also:

read()

void Buffer::pop

(

)

Pops first item from list

See also:

read()

void Buffer::pop

(

)

Pops first item from list

See also:

read()

void Buffer::pop

(

)

Pops first item from list

See also:

read()

void Buffer::pop

(

)

Pops first item from list

See also:

read()

Definition at line 50 of file buffer.cpp.

void Buffer::push

(

char

c

)

Adds character to the end of buffer

Parameters:

c	- character to add

void Buffer::push

(

char

c

)

Adds character to the end of buffer

Parameters:

c	- character to add

Definition at line 40 of file buffer.cpp.

void Buffer::push

(

char

c

)

Adds character to the end of buffer

Parameters:

c	- character to add

void Buffer::push

(

char

c

)

Adds character to the end of buffer

Parameters:

c	- character to add

unsigned char Buffer::read

(

)

Pops first item from list and returns it

Returns:

first item

See also:

pop()

unsigned char Buffer::read

(

)

Pops first item from list and returns it

Returns:

first item

See also:

pop()

Definition at line 67 of file buffer.cpp.

unsigned char Buffer::read

(

)

Pops first item from list and returns it

Returns:

first item

See also:

pop()

unsigned char Buffer::read

(

)

Pops first item from list and returns it

Returns:

first item

See also:

pop()

int Buffer::size

(

)

int Buffer::size

(

)

int Buffer::size

(

)

int Buffer::size

(

)

Definition at line 63 of file buffer.cpp.

---

Member Data Documentation

BufferItem * Buffer::_head

Definition at line 100 of file buffer.h.

int Buffer::_size

Definition at line 99 of file buffer.h.

BufferItem * Buffer::_tail

Definition at line 100 of file buffer.h.

---

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

• lib/usart/buffer.h
• receiver/firmware/buffer.h
• transmiter/firmware/buffer.h
• uec/firmware/buffer.h
• lib/usart/buffer.cpp
• receiver/firmware/buffer.cpp
• transmiter/firmware/buffer.cpp
• uec/firmware/buffer.cpp