Public Member Functions | Private 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 Member Functions

void lock ()
 

Private Attributes

boost::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 48 of file realtime_buffer.h.

Constructor & Destructor Documentation

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

Definition at line 51 of file realtime_buffer.h.

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 64 of file realtime_buffer.h.

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

Definition at line 71 of file realtime_buffer.h.

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

Definition at line 79 of file realtime_buffer.h.

Member Function Documentation

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

Definition at line 144 of file realtime_buffer.h.

template<class T >
void realtime_tools::RealtimeBuffer< T >::lock ( )
inlineprivate

Definition at line 151 of file realtime_buffer.h.

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

Custom assignment operator.

Definition at line 92 of file realtime_buffer.h.

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

Definition at line 121 of file realtime_buffer.h.

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

Definition at line 103 of file realtime_buffer.h.

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

Definition at line 131 of file realtime_buffer.h.

Member Data Documentation

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

Definition at line 166 of file realtime_buffer.h.

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

Definition at line 163 of file realtime_buffer.h.

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

Definition at line 162 of file realtime_buffer.h.

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

Definition at line 161 of file realtime_buffer.h.


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


realtime_tools
Author(s): Stuart Glaser
autogenerated on Mon Mar 22 2021 02:20:09