Public Member Functions | Protected Attributes | List of all members
vigir_footstep_planning::threading::Queue< T > Class Template Reference

#include <queue.h>

Public Member Functions

void clear ()
 
bool hasOpenJobs () const
 
void justFinishedJobs (unsigned int n)
 
 Queue ()
 
void queueJob (boost::shared_ptr< T > &job)
 
void queueJobs (std::list< boost::shared_ptr< T > > &jobs)
 
boost::shared_ptr< T > & waitAndDequeueJob ()
 
void waitAndDequeueJobs (std::vector< boost::shared_ptr< T > > &jobs, unsigned int n)
 
void waitUntilJobsProcessed () const
 
virtual ~Queue ()
 

Protected Attributes

unsigned int job_counter
 
boost::condition_variable jobs_finished_condition
 
std::queue< boost::shared_ptr< T > > queued_jobs
 
boost::condition_variable queued_jobs_condition
 
boost::mutex queued_jobs_mutex
 

Detailed Description

template<class T>
class vigir_footstep_planning::threading::Queue< T >

Definition at line 45 of file queue.h.

Constructor & Destructor Documentation

template<class T>
vigir_footstep_planning::threading::Queue< T >::Queue ( )
inline

Definition at line 48 of file queue.h.

template<class T>
virtual vigir_footstep_planning::threading::Queue< T >::~Queue ( )
inlinevirtual

Definition at line 53 of file queue.h.

Member Function Documentation

template<class T>
void vigir_footstep_planning::threading::Queue< T >::clear ( )
inline

Definition at line 57 of file queue.h.

template<class T>
bool vigir_footstep_planning::threading::Queue< T >::hasOpenJobs ( ) const
inline

Definition at line 141 of file queue.h.

template<class T>
void vigir_footstep_planning::threading::Queue< T >::justFinishedJobs ( unsigned int  n)
inline

Definition at line 125 of file queue.h.

template<class T>
void vigir_footstep_planning::threading::Queue< T >::queueJob ( boost::shared_ptr< T > &  job)
inline

Definition at line 65 of file queue.h.

template<class T>
void vigir_footstep_planning::threading::Queue< T >::queueJobs ( std::list< boost::shared_ptr< T > > &  jobs)
inline

Definition at line 74 of file queue.h.

template<class T>
boost::shared_ptr<T>& vigir_footstep_planning::threading::Queue< T >::waitAndDequeueJob ( )
inline

Definition at line 84 of file queue.h.

template<class T>
void vigir_footstep_planning::threading::Queue< T >::waitAndDequeueJobs ( std::vector< boost::shared_ptr< T > > &  jobs,
unsigned int  n 
)
inline

Definition at line 103 of file queue.h.

template<class T>
void vigir_footstep_planning::threading::Queue< T >::waitUntilJobsProcessed ( ) const
inline

Definition at line 147 of file queue.h.

Member Data Documentation

template<class T>
unsigned int vigir_footstep_planning::threading::Queue< T >::job_counter
protected

Definition at line 161 of file queue.h.

template<class T>
boost::condition_variable vigir_footstep_planning::threading::Queue< T >::jobs_finished_condition
mutableprotected

Definition at line 166 of file queue.h.

template<class T>
std::queue<boost::shared_ptr<T> > vigir_footstep_planning::threading::Queue< T >::queued_jobs
protected

Definition at line 160 of file queue.h.

template<class T>
boost::condition_variable vigir_footstep_planning::threading::Queue< T >::queued_jobs_condition
mutableprotected

Definition at line 165 of file queue.h.

template<class T>
boost::mutex vigir_footstep_planning::threading::Queue< T >::queued_jobs_mutex
mutableprotected

Definition at line 163 of file queue.h.


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


vigir_footstep_planning_lib
Author(s): Alexander Stumpf
autogenerated on Mon Jun 10 2019 15:47:33