OpenNI 1.5.4: XnEventInterfaceT< FuncPtr > Class Template Reference

OpenNI

XnEventInterfaceT< FuncPtr > Class Template Reference

#include <XnEventT.h>

List of all members.

Public Types

typedef FuncPtr HandlerPtr
typedef XnCallbackT< FuncPtr > TCallback
typedef XnEventInterfaceT TInterface

Public Member Functions

 ~XnEventInterfaceT ()
XnStatus Register (FuncPtr pFunc, void *pCookie, XnCallbackHandle &hCallback)
XnStatus Unregister (XnCallbackHandle hCallback)

Protected Types

typedef XnListT< TCallback * > CallbackPtrList

Protected Member Functions

 XnEventInterfaceT ()
 XnEventInterfaceT (const XnEventInterfaceT &other)
XnEventInterfaceToperator= (const XnEventInterfaceT &other)
XnStatus Clear ()
XnStatus ApplyListChanges ()
XnBool RemoveCallback (CallbackPtrList &list, TCallback *pCallback)

Protected Attributes

XN_CRITICAL_SECTION_HANDLE m_hLock
CallbackPtrList m_callbacks
CallbackPtrList m_toAdd
CallbackPtrList m_toRemove

Detailed Description

template<typename FuncPtr>
class XnEventInterfaceT< FuncPtr >

A class that contains the interface of an event (i.e. Register and Unregister)

Template Parameters:
FuncPtrThe callback signature

Member Typedef Documentation

template<typename FuncPtr>
typedef XnListT<TCallback*> XnEventInterfaceT< FuncPtr >::CallbackPtrList [protected]
template<typename FuncPtr>
typedef FuncPtr XnEventInterfaceT< FuncPtr >::HandlerPtr
template<typename FuncPtr>
typedef XnCallbackT<FuncPtr> XnEventInterfaceT< FuncPtr >::TCallback
template<typename FuncPtr>
typedef XnEventInterfaceT XnEventInterfaceT< FuncPtr >::TInterface

Constructor & Destructor Documentation

template<typename FuncPtr>
XnEventInterfaceT< FuncPtr >::~XnEventInterfaceT ( ) [inline]
template<typename FuncPtr>
XnEventInterfaceT< FuncPtr >::XnEventInterfaceT ( ) [inline, protected]
template<typename FuncPtr>
XnEventInterfaceT< FuncPtr >::XnEventInterfaceT ( const XnEventInterfaceT< FuncPtr > &  other) [inline, protected]

Member Function Documentation

template<typename FuncPtr>
XnStatus XnEventInterfaceT< FuncPtr >::ApplyListChanges ( ) [inline, protected]
template<typename FuncPtr>
XnStatus XnEventInterfaceT< FuncPtr >::Clear ( ) [inline, protected]
template<typename FuncPtr>
XnEventInterfaceT& XnEventInterfaceT< FuncPtr >::operator= ( const XnEventInterfaceT< FuncPtr > &  other) [inline, protected]
template<typename FuncPtr>
XnStatus XnEventInterfaceT< FuncPtr >::Register ( FuncPtr  pFunc,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]
template<typename FuncPtr>
XnBool XnEventInterfaceT< FuncPtr >::RemoveCallback ( CallbackPtrList list,
TCallback pCallback 
) [inline, protected]
template<typename FuncPtr>
XnStatus XnEventInterfaceT< FuncPtr >::Unregister ( XnCallbackHandle  hCallback) [inline]

Member Data Documentation

template<typename FuncPtr>
CallbackPtrList XnEventInterfaceT< FuncPtr >::m_callbacks [protected]
template<typename FuncPtr>
XN_CRITICAL_SECTION_HANDLE XnEventInterfaceT< FuncPtr >::m_hLock [protected]
template<typename FuncPtr>
CallbackPtrList XnEventInterfaceT< FuncPtr >::m_toAdd [protected]
template<typename FuncPtr>
CallbackPtrList XnEventInterfaceT< FuncPtr >::m_toRemove [protected]

The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen 1.7.5.1