The FrameQueue class implements a queue, to manage a set of CCF DataFrame instances as a ring buffer. More...
#include <frameQueue.hpp>
Public Member Functions | |
| FrameQueue (const std::string &name, const uint16_t nb_of_buffers) | |
| Instantiate a Frame Queue with the given name and the given number of buffers (DataFrame instances). | |
| ~FrameQueue () | |
| void | Reset () |
| Reset the Frame Queue object. This means in practice to reset/free the DataFrame objects in the queue. | |
| const std::string & | GetName () const |
| Return the name of the Frame Queue. | |
| void | GetFreeFrame (const uint16_t consumers, DataFrame **frame) |
| void | GetFrame (uint16_t frame_number, DataFrame **frame) |
| Get reference to the given frame number in the queue. | |
| uint16_t | GetNbOfBuffers () const |
| Return the number of buffers in the queue. | |
| uint16_t | GetNbOfFreeBuffers () |
| Return the number of free buffers in the queue. | |
 Public Member Functions inherited from ifw::ccf::Base | |
| Base () | |
| ~Base () | |
| const std::string & | GetClassName () const |
| Return the allocated name of the class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ifw::ccf::Base | |
| static ifw::ccf::mptk::Manager & | Mptk () |
| Return reference to internal MPTK instance (singleton). | |
| Protected Member Functions inherited from ifw::ccf::Base | |
| void | SetClassName (const std::string &class_name) |
| Set the name of the class in question. | |
Detailed Description
The FrameQueue class implements a queue, to manage a set of CCF DataFrame instances as a ring buffer.
Constructor & Destructor Documentation
◆ FrameQueue()
| ifw::ccf::common::FrameQueue::FrameQueue | ( | const std::string & | name, |
| const uint16_t | nb_of_buffers ) |
Instantiate a Frame Queue with the given name and the given number of buffers (DataFrame instances).
◆ ~FrameQueue()
| ifw::ccf::common::FrameQueue::~FrameQueue | ( | ) |
Member Function Documentation
◆ GetFrame()
| void ifw::ccf::common::FrameQueue::GetFrame | ( | uint16_t | frame_number, |
| DataFrame ** | frame ) |
Get reference to the given frame number in the queue.
◆ GetFreeFrame()
| void ifw::ccf::common::FrameQueue::GetFreeFrame | ( | const uint16_t | consumers, |
| DataFrame ** | frame ) |
Get a free Data Frame from the queue, i.e. a frame object not having any consumers signed up. The "consumers" parameter indicates how many consumers will be using the data in the frame before it can be considered as free.
◆ GetName()
| const std::string & ifw::ccf::common::FrameQueue::GetName | ( | ) | const |
Return the name of the Frame Queue.
◆ GetNbOfBuffers()
| uint16_t ifw::ccf::common::FrameQueue::GetNbOfBuffers | ( | ) | const |
Return the number of buffers in the queue.
◆ GetNbOfFreeBuffers()
| uint16_t ifw::ccf::common::FrameQueue::GetNbOfFreeBuffers | ( | ) |
Return the number of free buffers in the queue.
◆ Reset()
| void ifw::ccf::common::FrameQueue::Reset | ( | ) |
Reset the Frame Queue object. This means in practice to reset/free the DataFrame objects in the queue.
The documentation for this class was generated from the following files:
- common/src/include/ifw/ccf/common/frameQueue.hpp
- common/src/frameQueue.cpp
