VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtCallbackFunctionInfo< T_CallbackFunctionType > Struct Template Reference

DtCallbackList; DtNoArgumentCallbackList. More...

Inheritance diagram for DtCallbackFunctionInfo< T_CallbackFunctionType >:
Inheritance graph
[legend]

Public Member Functions

 DtCallbackFunctionInfo (T_CallbackFunctionType func, void *usr=0)
 
 DtCallbackFunctionInfo (const DtCallbackFunctionInfo &orig)
 
DtCallbackFunctionInfooperator= (const DtCallbackFunctionInfo &rhs)
 
bool operator< (const DtCallbackFunctionInfo &rhs) const
 
bool operator> (const DtCallbackFunctionInfo &rhs) const
 
bool operator== (const DtCallbackFunctionInfo &rhs) const
 
bool operator!= (const DtCallbackFunctionInfo &rhs) const
 
void setIsDeleted (bool b)
 
bool isDeleted () const
 
const T_CallbackFunctionType & getCallback () const
 
void * userData () const
 

Protected Attributes

boost::shared_ptr< booldeletedFlag
 
T_CallbackFunctionType callback
 
void * usrData
 

Detailed Description

template<typename T_CallbackFunctionType>
struct DtCallbackFunctionInfo< T_CallbackFunctionType >

DtCallbackList; DtNoArgumentCallbackList.

This is a templated class which manages a list of callbacks. A class is instantiated from this template by specifying the argument to be passed into the callback function. A callback function signature is created by this class (as the DtCallbackFunctionType definition) using the specified argument.

Note
It is safe to add and remove callbacks from this table during callback invokation, so callbacks functions may safely remove themselves.
It is safe to add and remove callbacks simultaneously from multiple threads.
A version of this class for callback with no arguments is DtNoArgumentCallbackList.

Constructor & Destructor Documentation

template<typename T_CallbackFunctionType>
DtCallbackFunctionInfo< T_CallbackFunctionType >::DtCallbackFunctionInfo ( T_CallbackFunctionType  func,
void *  usr = 0 
)
inline
template<typename T_CallbackFunctionType>
DtCallbackFunctionInfo< T_CallbackFunctionType >::DtCallbackFunctionInfo ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  orig)
inline

Member Function Documentation

template<typename T_CallbackFunctionType>
DtCallbackFunctionInfo& DtCallbackFunctionInfo< T_CallbackFunctionType >::operator= ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  rhs)
inline
template<typename T_CallbackFunctionType>
bool DtCallbackFunctionInfo< T_CallbackFunctionType >::operator< ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  rhs) const
inline
template<typename T_CallbackFunctionType>
bool DtCallbackFunctionInfo< T_CallbackFunctionType >::operator> ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  rhs) const
inline
template<typename T_CallbackFunctionType>
bool DtCallbackFunctionInfo< T_CallbackFunctionType >::operator== ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  rhs) const
inline
template<typename T_CallbackFunctionType>
bool DtCallbackFunctionInfo< T_CallbackFunctionType >::operator!= ( const DtCallbackFunctionInfo< T_CallbackFunctionType > &  rhs) const
inline
template<typename T_CallbackFunctionType>
void DtCallbackFunctionInfo< T_CallbackFunctionType >::setIsDeleted ( bool  b)
inline
template<typename T_CallbackFunctionType>
bool DtCallbackFunctionInfo< T_CallbackFunctionType >::isDeleted ( ) const
inline
template<typename T_CallbackFunctionType>
const T_CallbackFunctionType& DtCallbackFunctionInfo< T_CallbackFunctionType >::getCallback ( ) const
inline
template<typename T_CallbackFunctionType>
void* DtCallbackFunctionInfo< T_CallbackFunctionType >::userData ( ) const
inline

Member Data Documentation

template<typename T_CallbackFunctionType>
boost::shared_ptr<bool> DtCallbackFunctionInfo< T_CallbackFunctionType >::deletedFlag
protected
template<typename T_CallbackFunctionType>
T_CallbackFunctionType DtCallbackFunctionInfo< T_CallbackFunctionType >::callback
protected
template<typename T_CallbackFunctionType>
void* DtCallbackFunctionInfo< T_CallbackFunctionType >::usrData
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)