FancySafeBot 0.0.1
A safe robotics library
Loading...
Searching...
No Matches
fsb::Queue< QueueType, QueueSize > Class Template Reference

Detailed Description

template<typename QueueType, size_t QueueSize>
class fsb::Queue< QueueType, QueueSize >

Queue.

#include <fsb_queue.h>

Collaboration diagram for fsb::Queue< QueueType, QueueSize >:
Collaboration graph

Public Member Functions

 Queue (const Queue &)=delete
 
Queueoperator= (const Queue &)=delete
 
 Queue (Queue &&)=delete
 
Queueoperator= (Queue &&)=delete
 
QueueStatus Push (QueueType push_value)
 Add value to buffer if there is space available.
 
QueueStatus ForcePush (QueueType push_value)
 Add value to buffer and overwrite oldest value if buffer is full.
 
QueueStatus Pop (QueueType &popped_value)
 Get oldest value from buffer.
 
QueueStatus PopAll (std::array< QueueType, QueueSize > &popped_values, size_t &num_popped)
 Wait for a new value to be added to the buffer, then pop all values.
 
QueueStatus PopWait (std::array< QueueType, QueueSize > &popped_values, size_t &num_popped, const struct timespec &timeout)
 Wait for a new value to be added to the buffer, then pop all values.
 
QueueStatus Reset ()
 Reset buffer to empty state.
 

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