API 4.4.1-2022-10-19-2c4045e59
For MATLAB, Python, Java, and C++ users
OpenSim::DataQueue_< T > Class Template Reference

DataQueue is a wrapper around the std::queue customized to handle data processing and synchronization, and limiting the interface to only the subset of operations needed for this use case. More...

Public Member Functions

virtual ~DataQueue_ ()
 
 DataQueue_ ()=default
 
 DataQueue_ (const DataQueue_ &other)
 
 DataQueue_ (DataQueue_ &&other)
 
DataQueue_operator= (const DataQueue_ &other)
 
void push_back (const double time, const SimTK::RowVectorView_< T > &data)
 
void pop_front (double &time, SimTK::RowVector_< T > &data)
 
bool isEmpty ()
 

Detailed Description

template<class T>
class OpenSim::DataQueue_< T >

DataQueue is a wrapper around the std::queue customized to handle data processing and synchronization, and limiting the interface to only the subset of operations needed for this use case.

Synchronization is experimental as of now. Client is responsible for making sure order is preserved. timestamp is required to pass in data so that clients can enforce order, however timestamp is not used/order-enforced internally.

Constructor & Destructor Documentation

◆ ~DataQueue_()

template<class T >
virtual OpenSim::DataQueue_< T >::~DataQueue_ ( )
inlinevirtual

◆ DataQueue_() [1/3]

template<class T >
OpenSim::DataQueue_< T >::DataQueue_ ( )
default

◆ DataQueue_() [2/3]

template<class T >
OpenSim::DataQueue_< T >::DataQueue_ ( const DataQueue_< T > &  other)
inline

◆ DataQueue_() [3/3]

template<class T >
OpenSim::DataQueue_< T >::DataQueue_ ( DataQueue_< T > &&  other)
inline

Member Function Documentation

◆ isEmpty()

template<class T >
bool OpenSim::DataQueue_< T >::isEmpty ( )
inline

◆ operator=()

template<class T >
DataQueue_ & OpenSim::DataQueue_< T >::operator= ( const DataQueue_< T > &  other)
inline

◆ pop_front()

template<class T >
void OpenSim::DataQueue_< T >::pop_front ( double &  time,
SimTK::RowVector_< T > &  data 
)
inline

◆ push_back()

template<class T >
void OpenSim::DataQueue_< T >::push_back ( const double  time,
const SimTK::RowVectorView_< T > &  data 
)
inline

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