VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType > Class Template Reference
#include <ThreadedFunctions.h>
Inheritance diagram for VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >:
List of all members.
|
Public Types |
typedef NullClassType3< ParamType1,
ParamType2, ParamType3 > | NullClassType |
| typedef void(* | ProcPtr )(ParamType1 p1, ParamType2 p2, ParamType3 p3) |
| typedef void(* | ProcThreadPtr )(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3) |
| typedef void(ClassType::* | ClassProcPtr )(ParamType1 p1, ParamType2 p2, ParamType3 p3) |
| typedef void(ClassType::* | ClassThreadProcPtr )(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3) |
typedef ThreadedProcedure3<
ParamType1, ParamType2, ParamType3,
ClassType > | BaseClass |
Public Member Functions |
| | ThreadedProcedure3 (ParamType1 p1, ParamType2 p2, ParamType3 p3, ProcPtr procPtr) |
| | ThreadedProcedure3 (ParamType1 p1, ParamType2 p2, ParamType3 p3, ProcThreadPtr procPtr) |
| | ThreadedProcedure3 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, ClassProcPtr procPtr) |
| | ThreadedProcedure3 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, ClassThreadProcPtr procPtr) |
| virtual bool | run () |
| | Executes the runnable code.
|
| virtual void | stop () |
| | stops the task from running.
|
| Runnable * | getParams () |
| Thread * | invoke () |
Protected Member Functions |
| | ThreadedProcedure3 (ParamType1 p1, ParamType2 p2, ParamType3 p3) |
Protected Attributes |
| ParamType1 | param1_ |
| ParamType2 | param2_ |
| ParamType3 | param3_ |
| Runnable * | internalParams_ |
| Thread * | runningThread_ |
| ProcPtr | procPtr_ |
| ProcThreadPtr | procThreadPtr_ |
| ClassProcPtr | classProcPtr_ |
| ClassThreadProcPtr | classThreadProcPtr_ |
| ClassType * | instancePtr_ |
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>>
class VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >
Member Typedef Documentation
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef ThreadedProcedure3<ParamType1,ParamType2,ParamType3,ClassType> VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::BaseClass |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef void(ClassType::* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ClassProcPtr)(ParamType1 p1, ParamType2 p2, ParamType3 p3) |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef void(ClassType::* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ClassThreadProcPtr)(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3) |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef NullClassType3<ParamType1,ParamType2,ParamType3> VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::NullClassType |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef void(* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ProcPtr)(ParamType1 p1, ParamType2 p2, ParamType3 p3) |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| typedef void(* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ProcThreadPtr)(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3) |
|
Constructor & Destructor Documentation
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ThreadedProcedure3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ProcPtr |
procPtr |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ThreadedProcedure3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ProcThreadPtr |
procPtr |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ThreadedProcedure3 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ClassProcPtr |
procPtr |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ThreadedProcedure3 |
( |
ClassType * |
src, |
|
|
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3, |
|
|
ClassThreadProcPtr |
procPtr |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::ThreadedProcedure3 |
( |
ParamType1 |
p1, |
|
|
ParamType2 |
p2, |
|
|
ParamType3 |
p3 |
|
) |
[inline, protected] |
|
Member Function Documentation
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| Runnable* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::getParams |
( |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| Thread* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::invoke |
( |
|
) |
[inline] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| virtual bool VCF::ThreadedProcedure3< 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 ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
| virtual void VCF::ThreadedProcedure3< 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 ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ClassProcPtr VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::classProcPtr_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ClassType* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::instancePtr_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
Runnable* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::internalParams_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ParamType1 VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::param1_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ParamType2 VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::param2_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ParamType3 VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::param3_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ProcPtr VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::procPtr_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
ProcThreadPtr VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::procThreadPtr_ [protected] |
|
|
template<typename ParamType1, typename ParamType2, typename ParamType3, typename ClassType = NullClassType3<ParamType1,ParamType2,ParamType3>> |
Thread* VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >::runningThread_ [protected] |
|
The documentation for this class was generated from the following file:
