« Back to documentation index
FIFO< T > Class Template Reference
Variable Length Software Ring Buffer.
More...
#include <FIFO.hpp >
FIFO (uint32_t bufsize) Create a new FIFO . virtual ~FIFO (void) Destroy the FIFO . virtual void clear (void) Clear the buffer. virtual uint32_t getsize (void) Get buffer size. virtual T get (void) Get byte from the buffer. virtual T peek (void) Peek byte from the buffer Peek 1byte from the buffer. virtual void put (const T putdata) Put byte to the buffer. virtual uint32_t available (void) Get Size of Retained Data. FIFO & operator= (T data) Overloaded operator for putting data to the FIFO . operator int (void) Overloaded operator for getting data from the FIFO .
Detailed Description
template<typename T>
Variable Length Software Ring Buffer.
Definition at line 41 of file FIFO.hpp .
Constructor & Destructor Documentation
FIFO (
uint32_t
bufsize )
Create a new FIFO .
Parameters:
Definition at line 28 of file FIFO.cpp .
Member Function Documentation
uint32_t available
(
void
)
[virtual]
Get Size of Retained Data.
Parameters:
Returns: Data size. Definition at line 117 of file FIFO.cpp .
void clear
(
void
)
[virtual]
Clear the buffer.
Parameters:
Definition at line 44 of file FIFO.cpp .
Get byte from the buffer.
Parameters:
Return values:
Definition at line 62 of file FIFO.cpp .
uint32_t getsize
(
void
)
[virtual]
Get buffer size.
Parameters:
Returns: Buffer size Definition at line 57 of file FIFO.cpp .
Overloaded operator for getting data from the FIFO .
Parameters:
Returns: Oldest Data Definition at line 121 of file FIFO.hpp .
FIFO & operator= (
T
data )
Overloaded operator for putting data to the FIFO .
Parameters:
Definition at line 111 of file FIFO.hpp .
T peek
(
void
)
[virtual]
Peek byte from the buffer Peek 1byte from the buffer.
(Do not touch index)
Parameters:
Return values:
Definition at line 85 of file FIFO.cpp .
void put
(
const T
putdata )
[virtual]
Put byte to the buffer.
Parameters:
No Parameters. putdata The Data for Putting.
Returns: Nothing. Definition at line 101 of file FIFO.cpp .
1.7.2