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