VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType > Class Template Reference
#include <ThreadedFunctions.h>
Inheritance diagram for VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >:
List of all members.
|
Public Types |
typedef NullReturnClassType2<
ReturnType, ParamType1, ParamType2 > | NullClassType |
| typedef ReturnType(* | FuncPtr )(ParamType1, ParamType2) |
| typedef ReturnType(* | FuncThreadPtr )(Thread *, ParamType1, ParamType2) |
| typedef ReturnType(ClassType::* | ClassFuncPtr )(ParamType1, ParamType2) |
| typedef ReturnType(ClassType::* | ClassThreadFuncPtr )(Thread *, ParamType1, ParamType2) |
typedef ThreadedFunction2<
ReturnType, ParamType1, ParamType2,
ClassType > | BaseClass |
Public Member Functions |
| | ThreadedFunction2 (ParamType1 p1, ParamType2 p2, FuncPtr funcPtr) |
| | ThreadedFunction2 (ParamType1 p1, ParamType2 p2, FuncThreadPtr funcPtr) |
| | ThreadedFunction2 (ClassType *src, ParamType1 p1, ParamType2 p2, ClassFuncPtr funcPtr) |
| | ThreadedFunction2 (ClassType *src, ParamType1 p1, ParamType2 p2, ClassThreadFuncPtr funcPtr) |
| virtual bool | run () |
| | Executes the runnable code.
|
| virtual void | stop () |
| | stops the task from running.
|
| Runnable * | getParams () |
| Thread * | invoke () |
| ReturnType | returnValue () |
Protected Member Functions |
| | ThreadedFunction2 (ParamType1 p1, ParamType2 p2) |
Protected Attributes |
| ReturnType | returnVal_ |
| ParamType1 | param1_ |
| ParamType2 | param2_ |
| Runnable * | internalParams_ |
| Thread * | runningThread_ |
| FuncPtr | funcPtr_ |
| FuncThreadPtr | threadFuncPtr_ |
| ClassFuncPtr | classFuncPtr_ |
| ClassThreadFuncPtr | classThreadFuncPtr_ |
| ClassType * | instancePtr_ |
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>>
class VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >
Member Typedef Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef ThreadedFunction2<ReturnType,ParamType1,ParamType2,ClassType> VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::BaseClass |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef ReturnType(ClassType::* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ClassFuncPtr)(ParamType1, ParamType2) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef ReturnType(ClassType::* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ClassThreadFuncPtr)(Thread *, ParamType1, ParamType2) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef ReturnType(* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::FuncPtr)(ParamType1, ParamType2) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef ReturnType(* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::FuncThreadPtr)(Thread *, ParamType1, ParamType2) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| typedef NullReturnClassType2<ReturnType,ParamType1,ParamType2> VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::NullClassType |
|
Constructor & Destructor Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ThreadedFunction2 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
FuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ThreadedFunction2 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
FuncThreadPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ThreadedFunction2 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ClassFuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ThreadedFunction2 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ClassThreadFuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::ThreadedFunction2 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2 |
|
) |
[inline, protected] |
|
Member Function Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| Runnable* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::getParams |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| Thread* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::invoke |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| ReturnType VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::returnValue |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| virtual bool VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::run |
( |
|
) |
[inline, virtual] |
|
|
|
Executes the runnable code.
- Returns:
- returns true is the execution was suvvessful, or false if not.
Implements VCF::Runnable. |
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
| virtual void VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::stop |
( |
|
) |
[inline, virtual] |
|
|
|
stops the task from running.
Should allow the implementer to gracefully finish whatever they were doing and exit the run() method as soon as possible.
Implements VCF::Runnable. |
Member Data Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
ClassFuncPtr VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::classFuncPtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
FuncPtr VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::funcPtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
ClassType* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::instancePtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
Runnable* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::internalParams_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
ParamType1 VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::param1_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
ParamType2 VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::param2_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
ReturnType VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::returnVal_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
Thread* VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::runningThread_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ClassType = NullReturnClassType2<ReturnType,ParamType1,ParamType2>> |
FuncThreadPtr VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >::threadFuncPtr_ [protected] |
|
The documentation for this class was generated from the following file:
