The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType > Class Template Reference

#include <ThreadedFunctions.h>

Inheritance diagram for VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >:

List of all members.

Public Types
typedef NullClassType5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5 >	NullClassType
typedef void(*	ProcPtr )(ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)
typedef void(*	ProcThreadPtr )(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)
typedef void(ClassType::*	ClassProcPtr )(ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)
typedef void(ClassType::*	ClassThreadProcPtr )(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)
typedef ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >	BaseClass
Public Member Functions
	ThreadedProcedure5 (ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5, ProcPtr procPtr)
	ThreadedProcedure5 (ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5, ProcThreadPtr procPtr)
	ThreadedProcedure5 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5, ProcThreadPtr procPtr)
	ThreadedProcedure5 (ClassType *src, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5, ClassThreadProcPtr procPtr)
virtual bool	run ()
	Executes the runnable code.
virtual void	stop ()
	stops the task from running.
Runnable *	getParams ()
Thread *	invoke ()
Protected Member Functions
	ThreadedProcedure5 (ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)
Protected Attributes
ParamType1	param1_
ParamType2	param2_
ParamType3	param3_
ParamType4	param4_
ParamType5	param5_
Runnable *	internalParams_
Thread *	runningThread_
ProcPtr	procPtr_
ProcThreadPtr	procThreadPtr_
ClassProcPtr	classProcPtr_
ClassThreadProcPtr	classThreadProcPtr_
ClassType *	instancePtr_

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>>
class VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >

---

Member Typedef Documentation

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef ThreadedProcedure5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5,ClassType> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::BaseClass

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef void(ClassType::* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ClassProcPtr)(ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef void(ClassType::* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ClassThreadProcPtr)(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::NullClassType

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef void(* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ProcPtr)(ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> typedef void(* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ProcThreadPtr)(Thread *thread, ParamType1 p1, ParamType2 p2, ParamType3 p3, ParamType4 p4, ParamType5 p5)

---

Constructor & Destructor Documentation

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ThreadedProcedure5 (  ParamType1  p1, ParamType2  p2, ParamType3  p3, ParamType4  p4, ParamType5  p5, ProcPtr  procPtr )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ThreadedProcedure5 (  ParamType1  p1, ParamType2  p2, ParamType3  p3, ParamType4  p4, ParamType5  p5, ProcThreadPtr  procPtr )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ThreadedProcedure5 (  ClassType *  src, ParamType1  p1, ParamType2  p2, ParamType3  p3, ParamType4  p4, ParamType5  p5, ProcThreadPtr  procPtr )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ThreadedProcedure5 (  ClassType *  src, ParamType1  p1, ParamType2  p2, ParamType3  p3, ParamType4  p4, ParamType5  p5, ClassThreadProcPtr  procPtr )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::ThreadedProcedure5 (  ParamType1  p1, ParamType2  p2, ParamType3  p3, ParamType4  p4, ParamType5  p5 )  [inline, protected]

---

Member Function Documentation

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> Runnable* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::getParams (   )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> Thread* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::invoke (   )  [inline]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> virtual bool VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, 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 ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> virtual void VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, 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 ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ClassProcPtr VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::classProcPtr_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ClassThreadProcPtr VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::classThreadProcPtr_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ClassType* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::instancePtr_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> Runnable* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::internalParams_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ParamType1 VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::param1_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ParamType2 VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::param2_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ParamType3 VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::param3_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ParamType4 VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::param4_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ParamType5 VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::param5_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ProcPtr VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::procPtr_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> ProcThreadPtr VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::procThreadPtr_ [protected]

template<typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4, typename ParamType5, typename ClassType = NullClassType5<ParamType1,ParamType2,ParamType3,ParamType4,ParamType5>> Thread* VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >::runningThread_ [protected]

---

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

• vcf/FoundationKit/ThreadedFunctions.h

Comments or Suggestions?    License Information