Account
| ArmsysApi 0.12.18 |
BCanPacketFifo Class Reference
#include <BCan.h>
Inheritance diagram for BCanPacketFifo:
Public Member Functions | |
| BCanPacketFifo (BUInt fifoSize) | |
 Public Member Functions inherited from BFifo< char > | |
| BFifo (BUInt size) | |
| ~BFifo () | |
| void | clear () |
| BUInt | size () |
| Returns fifo size. More... | |
| BError | resize (BUInt size) |
| Resize FIFO, clears it as well. More... | |
| BError | rebase () |
| Rebases fifo so read pointer is at zero moving memory as needed. More... | |
| BUInt | writeAvailable () |
| How many items that can be written. More... | |
| BUInt | writeAvailableChunk () |
| How many items that can be written in a chunk. More... | |
| BError | write (const char v) |
| Write a single item. More... | |
| BError | write (const char *data, BUInt num) |
| Write a set of items. Can only write a maximum of writeAvailableChunk() to save going beyond end of FIFO buffer. More... | |
| char * | writeData () |
| Returns a pointer to the data. More... | |
| char * | writeData (BUInt &num) |
| Returns a pointer to the data and how many can be written in a chunk. More... | |
| void | writeDone (BUInt num) |
| Indicates when write is complete. More... | |
| void | writeBackup (BUInt num) |
| Backup, remove num items at end of fifo. Careful, make sure read is not already happening. More... | |
| BUInt | readAvailable () |
| How many items are available to read. More... | |
| BUInt | readAvailableChunk () |
| How many items are available to read in a chunk. More... | |
| char | read () |
| Read one item. More... | |
| BError | read (char *data, BUInt num) |
| Read a set of items. More... | |
| BError | readPeak (char *data, BUInt num) |
| Read a set of items leaving them in the buffer. More... | |
| char * | readData () |
| Returns a pointer to the data. More... | |
| char * | readData (BUInt &num) |
| Returns a pointer to the data and how many can be read in a chunk. More... | |
| void | readDone (BUInt num) |
| char | readPos (BUInt pos) |
| Read item at given offset from current read position. More... | |
| void | writePos (BUInt pos, const char &v) |
| Write item at given offset from current read position. More... | |
| char & | operator[] (int pos) |
| Direct access to read samples in buffer. More... | |
Public Attributes | |
| Bool | inPacket |
| BUInt16 | num |
| BFifo< BUInt16 > | numFifo |
Additional Inherited Members | |
| Protected Attributes inherited from BFifo< char > | |
| BUInt | osize |
| The size of the FIFO. More... | |
| char * | odata |
| FIFO memory buffer. More... | |
| volatile BUInt | owritePos |
| The write pointer. More... | |
| volatile BUInt | oreadPos |
| The read pointer. More... | |
Constructor & Destructor Documentation
◆ BCanPacketFifo()
| BCanPacketFifo::BCanPacketFifo | ( | BUInt | fifoSize | ) |
Member Data Documentation
◆ inPacket
| Bool BCanPacketFifo::inPacket |
◆ num
| BUInt16 BCanPacketFifo::num |
◆ numFifo
The documentation for this class was generated from the following files:
Generated by
1.8.15