VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType > Class Template Reference
#include <ThreadedFunctions.h>
Inheritance diagram for VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >:
List of all members.
|
Public Types |
typedef NullReturnClassType3<
ReturnType, ParamType1, ParamType2,
ParamType3 > | NullClassType |
| typedef ReturnType(* | FuncPtr )(ParamType1, ParamType2, ParamType3) |
| typedef ReturnType(* | FuncThreadPtr )(Thread *, ParamType1, ParamType2, ParamType3) |
| typedef ReturnType(ClassType::* | ClassFuncPtr )(ParamType1, ParamType2, ParamType3) |
| typedef ReturnType(ClassType::* | ClassThreadFuncPtr )(Thread *, ParamType1, ParamType2, ParamType3) |
typedef ThreadedFunction3<
ReturnType, ParamType1, ParamType2,
ParamType3, ClassType > | BaseClass |
Public Member Functions |
| | ThreadedFunction3 (ParamType1 p1, ParamType2 p2, ParamType3 p3, FuncPtr funcPtr) |
| | ThreadedFunction3 (ParamType1 p1, ParamType2 p2, ParamType3 p3, FuncThreadPtr funcPtr) |
| | ThreadedFunction3 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, ClassFuncPtr funcPtr) |
| | ThreadedFunction3 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, 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 |
| | ThreadedFunction3 (ParamType1 p1, ParamType2 p2, ParamType3 p3) |
Protected Attributes |
| ReturnType | returnVal_ |
| ParamType1 | param1_ |
| ParamType2 | param2_ |
| ParamType3 | param3_ |
| Runnable * | internalParams_ |
| Thread * | runningThread_ |
| FuncPtr | funcPtr_ |
| FuncThreadPtr | threadFuncPtr_ |
| ClassFuncPtr | classFuncPtr_ |
| ClassThreadFuncPtr | classThreadFuncPtr_ |
| ClassType * | instancePtr_ |
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>>
class VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >
Member Typedef Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef ThreadedFunction3<ReturnType,ParamType1,ParamType2,ParamType3,ClassType> VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::BaseClass |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef ReturnType(ClassType::* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ClassFuncPtr)(ParamType1, ParamType2, ParamType3) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef ReturnType(ClassType::* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ClassThreadFuncPtr)(Thread *, ParamType1, ParamType2, ParamType3) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef ReturnType(* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::FuncPtr)(ParamType1, ParamType2, ParamType3) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef ReturnType(* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::FuncThreadPtr)(Thread *, ParamType1, ParamType2, ParamType3) |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| typedef NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3> VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::NullClassType |
|
Constructor & Destructor Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ThreadedFunction3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
FuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ThreadedFunction3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
FuncThreadPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ThreadedFunction3 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ClassFuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ThreadedFunction3 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ClassThreadFuncPtr |
funcPtr |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::ThreadedFunction3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3 |
|
) |
[inline, protected] |
|
Member Function Documentation
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| Runnable* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::getParams |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| Thread* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::invoke |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| ReturnType VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::returnValue |
( |
|
) |
[inline] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| virtual bool VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, 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 ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
| virtual void VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, 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 ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ClassFuncPtr VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::classFuncPtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ClassThreadFuncPtr VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::classThreadFuncPtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
FuncPtr VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::funcPtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ClassType* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::instancePtr_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
Runnable* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::internalParams_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ParamType1 VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::param1_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ParamType2 VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::param2_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ParamType3 VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::param3_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
ReturnType VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::returnVal_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
Thread* VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::runningThread_ [protected] |
|
|
template<typename ReturnType, typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullReturnClassType3<ReturnType,ParamType1,ParamType2,ParamType3>> |
FuncThreadPtr VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >::threadFuncPtr_ [protected] |
|
The documentation for this class was generated from the following file:
