RTC Toolkit  1.0.0
Namespaces | Functions
readerHelpers.hpp File Reference

Helper methods to read data from shared memory queue. More...

#include "rtctk/componentFramework/logger.hpp"
#include <chrono>
#include <system_error>
#include <cmath>

Go to the source code of this file.

Namespaces

 rtctk
 
 rtctk::dataTask
 
 rtctk::dataTask::detail
 

Functions

std::chrono::milliseconds rtctk::dataTask::detail::CalcDuration (size_t count, size_t loop_frequency, float error_margin=1.0)
 free helper function to calulate the estimated time to read the a number of samples at a given frequency More...
 
std::pair< std::chrono::milliseconds, std::chrono::milliseconds > rtctk::dataTask::detail::CalcTimeout (size_t count, size_t loop_frequency, float error_margin=2.0)
 free helper function to calulate the timeouts required for the Read and Skip functions More...
 
template<typename ReaderType , typename Operation >
std::error_code rtctk::dataTask::detail::Read (ReaderType &reader, Operation &&op, size_t count, size_t loop_frequency, float error_margin=2.0)
 helper function to wrap the ipcq.read with handling of timeouts and count values More...
 
template<typename ReaderType >
std::error_code rtctk::dataTask::detail::Skip (ReaderType &reader, size_t count, size_t loop_frequency, float error_margin=2.0)
 helper function to wrap the ipcq.skip with handling of timeouts and count values More...
 
template<typename ReaderType >
std::error_code rtctk::dataTask::detail::Reset (ReaderType &reader)
 helper function to reset the ipcq.reader to latest sample More...
 
template<typename ReaderType >
size_t rtctk::dataTask::detail::NumFree (ReaderType &reader)
 helper function to get the free space in the shm. More...
 

Detailed Description

Helper methods to read data from shared memory queue.