Public Member Functions | Private Attributes | List of all members
realtime_tools::RealtimeBuffer< T > Class Template Reference

#include <realtime_buffer.h>

Public Member Functions

void initRT (const T &data)
 
RealtimeBufferoperator= (const RealtimeBuffer &source)
 Custom assignment operator. More...
 
T * readFromNonRT () const
 
T * readFromRT ()
 
 RealtimeBuffer ()
 
 RealtimeBuffer (const T &data)
 Constructor for objects that don't have a default constructor. More...
 
 RealtimeBuffer (const RealtimeBuffer &source)
 
void writeFromNonRT (const T &data)
 
 ~RealtimeBuffer ()
 

Private Attributes

std::mutex mutex_
 
bool new_data_available_
 
T * non_realtime_data_
 
T * realtime_data_
 

Detailed Description

template<class T>
class realtime_tools::RealtimeBuffer< T >

Definition at line 50 of file realtime_buffer.h.

Constructor & Destructor Documentation

◆ RealtimeBuffer() [1/3]

template<class T>
realtime_tools::RealtimeBuffer< T >::RealtimeBuffer ( )
inline

Definition at line 53 of file realtime_buffer.h.

◆ RealtimeBuffer() [2/3]

template<class T>
realtime_tools::RealtimeBuffer< T >::RealtimeBuffer ( const T &  data)
inline

Constructor for objects that don't have a default constructor.

Parameters
dataThe object to use as default value

Definition at line 66 of file realtime_buffer.h.

◆ ~RealtimeBuffer()

template<class T>
realtime_tools::RealtimeBuffer< T >::~RealtimeBuffer ( )
inline

Definition at line 73 of file realtime_buffer.h.

◆ RealtimeBuffer() [3/3]

template<class T>
realtime_tools::RealtimeBuffer< T >::RealtimeBuffer ( const RealtimeBuffer< T > &  source)
inline

Definition at line 81 of file realtime_buffer.h.

Member Function Documentation

◆ initRT()

template<class T>
void realtime_tools::RealtimeBuffer< T >::initRT ( const T &  data)
inline

Definition at line 150 of file realtime_buffer.h.

◆ operator=()

template<class T>
RealtimeBuffer& realtime_tools::RealtimeBuffer< T >::operator= ( const RealtimeBuffer< T > &  source)
inline

Custom assignment operator.

Definition at line 94 of file realtime_buffer.h.

◆ readFromNonRT()

template<class T>
T* realtime_tools::RealtimeBuffer< T >::readFromNonRT ( ) const
inline

Definition at line 123 of file realtime_buffer.h.

◆ readFromRT()

template<class T>
T* realtime_tools::RealtimeBuffer< T >::readFromRT ( )
inline

Definition at line 105 of file realtime_buffer.h.

◆ writeFromNonRT()

template<class T>
void realtime_tools::RealtimeBuffer< T >::writeFromNonRT ( const T &  data)
inline

Definition at line 133 of file realtime_buffer.h.

Member Data Documentation

◆ mutex_

template<class T>
std::mutex realtime_tools::RealtimeBuffer< T >::mutex_
mutableprivate

Definition at line 163 of file realtime_buffer.h.

◆ new_data_available_

template<class T>
bool realtime_tools::RealtimeBuffer< T >::new_data_available_
private

Definition at line 160 of file realtime_buffer.h.

◆ non_realtime_data_

template<class T>
T* realtime_tools::RealtimeBuffer< T >::non_realtime_data_
private

Definition at line 159 of file realtime_buffer.h.

◆ realtime_data_

template<class T>
T* realtime_tools::RealtimeBuffer< T >::realtime_data_
private

Definition at line 158 of file realtime_buffer.h.


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


realtime_tools
Author(s): Stuart Glaser
autogenerated on Tue Nov 19 2019 10:59:56