API  4.3
For MATLAB, Python, Java, and C++ users
List of all members | Public Member Functions
OpenSim::DataQueueEntry_< U > Class Template Reference

This base class defines the interface for a DataQueue. More...

Public Member Functions

 DataQueueEntry_ (double timeStamp, const SimTK::RowVectorView_< U > &data)
 
 DataQueueEntry_ (const DataQueueEntry_ &other)=default
 
 DataQueueEntry_ (DataQueueEntry_ &&)=default
 
DataQueueEntry_ & operator= (const DataQueueEntry_ &)=default
 
virtual ~DataQueueEntry_ ()
 
double getTimeStamp () const
 
SimTK::RowVectorView_< U > getData () const
 

Detailed Description

template<class U>
class OpenSim::DataQueueEntry_< U >

This base class defines the interface for a DataQueue.

A data structure to maintain a queue of data to be passed between computations that are potentially different in processing speeds, decoupling the producers (e.g. File or live stream) from consumers.

Synchronization mechanism will be implmented later to allow handling of multiple threads or significant differences in speeds.

Author
Ayman HabibTemplate class to contain Queue Entries, typically timestamped

Constructor & Destructor Documentation

◆ DataQueueEntry_() [1/3]

template<class U>
OpenSim::DataQueueEntry_< U >::DataQueueEntry_ ( double  timeStamp,
const SimTK::RowVectorView_< U > &  data 
)
inline

◆ DataQueueEntry_() [2/3]

template<class U>
OpenSim::DataQueueEntry_< U >::DataQueueEntry_ ( const DataQueueEntry_< U > &  other)
default

◆ DataQueueEntry_() [3/3]

template<class U>
OpenSim::DataQueueEntry_< U >::DataQueueEntry_ ( DataQueueEntry_< U > &&  )
default

◆ ~DataQueueEntry_()

template<class U>
virtual OpenSim::DataQueueEntry_< U >::~DataQueueEntry_ ( )
inlinevirtual

Member Function Documentation

◆ getData()

template<class U>
SimTK::RowVectorView_<U> OpenSim::DataQueueEntry_< U >::getData ( ) const
inline

Referenced by OpenSim::DataQueue_< SimTK::Rotation >::pop_front().

◆ getTimeStamp()

template<class U>
double OpenSim::DataQueueEntry_< U >::getTimeStamp ( ) const
inline

Referenced by OpenSim::DataQueue_< SimTK::Rotation >::pop_front().

◆ operator=()

template<class U>
DataQueueEntry_& OpenSim::DataQueueEntry_< U >::operator= ( const DataQueueEntry_< U > &  )
default
The documentation for this class was generated from the following file: