Image Component Library (ICL)
Public Member Functions | Private Member Functions | Private Attributes | List of all members
icl::io::OpenNIGrabberThread Class Reference

Internally spawned thread class for continuous grabbing. Only one instance needed. More...

#include <OpenNIGrabber.h>

Inheritance diagram for icl::io::OpenNIGrabberThread:
icl::utils::Thread icl::utils::ShallowCopyable< ThreadImpl, ThreadImplDelOp >

Public Member Functions

 OpenNIGrabberThread ()
 Constructor set up GrabberThread. More...
 
 ~OpenNIGrabberThread ()
 Destructor stops thread and releases all resources. More...
 
void addGrabber (OpenNIGrabber *grabber)
 adds a grabber to be updated every frame. More...
 
void removeGrabber (OpenNIGrabber *grabber)
 removes a grabber so it no longer will be updated. More...
 
- Public Member Functions inherited from icl::utils::Thread
 Thread ()
 Create a new Thread. More...
 
virtual ~Thread ()
 Destructor (if the thread is still running, it is ended) More...
 
void start ()
 starts the thread More...
 
virtual void stop ()
 stops the thread and waits till it is ended More...
 
void wait ()
 waits for this thread to be ended More...
 
virtual void finalize ()
 at the end of the stop function, this function is called More...
 
bool running () const
 returns the internal running state More...
 
bool runningNoLock () const
 returns the running state of the thread (without locking the mutex) More...
 
- Public Member Functions inherited from icl::utils::ShallowCopyable< ThreadImpl, ThreadImplDelOp >
bool isNull () const
 returns wheter the objects implementation holds a null pointer More...
 

Private Member Functions

void run ()
 constantly calls update on OpenNI context and updates image buffers. While grabbers are registered. More...
 

Private Attributes

std::set< OpenNIGrabber * > m_Grabber
 internally used set of grabber pointers More...
 

Additional Inherited Members

- Public Types inherited from icl::utils::ShallowCopyable< ThreadImpl, ThreadImplDelOp >
typedef ShallowCopyable< ThreadImpl, ThreadImplDelOp > ParentSC
 
- Static Public Member Functions inherited from icl::utils::Thread
static void usleep (unsigned int usec)
 just calling usleep More...
 
static void msleep (unsigned int msecs)
 sets the current thread to sleep for some milli-seconds More...
 
static void sleep (float secs)
 sets the current thread to sleep for some seconds More...
 
- Protected Member Functions inherited from icl::utils::Thread
void exit ()
 exits the thread using pthread_exit (must be called from within the run function) More...
 
void lock ()
 internal used lock function More...
 
int trylock ()
 internal used trylock function More...
 
void unlock ()
 internal used unlock function More...
 
void join ()
 internal used join function More...
 
- Protected Member Functions inherited from icl::utils::ShallowCopyable< ThreadImpl, ThreadImplDelOp >
 ShallowCopyable (ThreadImpl *t=0)
 create a the implementation with a given T* value More...
 
- Protected Attributes inherited from icl::utils::ShallowCopyable< ThreadImpl, ThreadImplDelOp >
SmartPtrBase< ThreadImpl, ThreadImplDelOp > impl
 shared pointer for the classes implementation More...
 

Detailed Description

Internally spawned thread class for continuous grabbing. Only one instance needed.

Constructor & Destructor Documentation

◆ OpenNIGrabberThread()

icl::io::OpenNIGrabberThread::OpenNIGrabberThread ( )

Constructor set up GrabberThread.

◆ ~OpenNIGrabberThread()

icl::io::OpenNIGrabberThread::~OpenNIGrabberThread ( )

Destructor stops thread and releases all resources.

Member Function Documentation

◆ addGrabber()

void icl::io::OpenNIGrabberThread::addGrabber ( OpenNIGrabber grabber)

adds a grabber to be updated every frame.

The thread should be stopped beforehand and restarted afterwards.

◆ removeGrabber()

void icl::io::OpenNIGrabberThread::removeGrabber ( OpenNIGrabber grabber)

removes a grabber so it no longer will be updated.

The thread should be stopped beforehand and restarted afterwards.

◆ run()

void icl::io::OpenNIGrabberThread::run ( )
privatevirtual

constantly calls update on OpenNI context and updates image buffers. While grabbers are registered.

Implements icl::utils::Thread.

Member Data Documentation

◆ m_Grabber

std::set<OpenNIGrabber*> icl::io::OpenNIGrabberThread::m_Grabber
private

internally used set of grabber pointers


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