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

VCF::ThreadedProcedure1< ParamType1, ClassType > Class Template Reference

#include <ThreadedFunctions.h>

Inheritance diagram for VCF::ThreadedProcedure1< ParamType1, ClassType >:

List of all members.

Public Types
typedef NullClassType1< ParamType1 >	NullClassType
typedef void(*	ProcPtr )(ParamType1 p1)
typedef void(*	ProcThreadPtr )(Thread *thread, ParamType1 p1)
typedef void(ClassType::*	ClassProcPtr )(ParamType1 p1)
typedef void(ClassType::*	ClassThreadProcPtr )(Thread *thread, ParamType1 p1)
typedef ThreadedProcedure1< ParamType1, ClassType >	BaseClass
Public Member Functions
	ThreadedProcedure1 (ParamType1 p1, ProcPtr procPtr)
	ThreadedProcedure1 (ParamType1 p1, ProcThreadPtr procPtr)
	ThreadedProcedure1 (ClassType *src, ParamType1 p1, ClassProcPtr procPtr)
	ThreadedProcedure1 (ClassType *src, ParamType1 p1, ClassThreadProcPtr procPtr)
virtual bool	run ()
	Executes the runnable code.
virtual void	stop ()
	stops the task from running.
Runnable *	getParams ()
Thread *	invoke ()
Protected Member Functions
	ThreadedProcedure1 (ParamType1 p1)
Protected Attributes
ParamType1	param1_
Runnable *	internalParams_
Thread *	runningThread_
ProcPtr	procPtr_
ProcThreadPtr	procThreadPtr_
ClassProcPtr	classProcPtr_
ClassThreadProcPtr	classThreadProcPtr_
ClassType *	instancePtr_

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>>
class VCF::ThreadedProcedure1< ParamType1, ClassType >

---

Member Typedef Documentation

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef ThreadedProcedure1<ParamType1,ClassType> VCF::ThreadedProcedure1< ParamType1, ClassType >::BaseClass

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef void(ClassType::* VCF::ThreadedProcedure1< ParamType1, ClassType >::ClassProcPtr)(ParamType1 p1)

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef void(ClassType::* VCF::ThreadedProcedure1< ParamType1, ClassType >::ClassThreadProcPtr)(Thread *thread, ParamType1 p1)

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef NullClassType1<ParamType1> VCF::ThreadedProcedure1< ParamType1, ClassType >::NullClassType

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef void(* VCF::ThreadedProcedure1< ParamType1, ClassType >::ProcPtr)(ParamType1 p1)

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> typedef void(* VCF::ThreadedProcedure1< ParamType1, ClassType >::ProcThreadPtr)(Thread *thread, ParamType1 p1)

---

Constructor & Destructor Documentation

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> VCF::ThreadedProcedure1< ParamType1, ClassType >::ThreadedProcedure1 (  ParamType1  p1, ProcPtr  procPtr )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> VCF::ThreadedProcedure1< ParamType1, ClassType >::ThreadedProcedure1 (  ParamType1  p1, ProcThreadPtr  procPtr )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> VCF::ThreadedProcedure1< ParamType1, ClassType >::ThreadedProcedure1 (  ClassType *  src, ParamType1  p1, ClassProcPtr  procPtr )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> VCF::ThreadedProcedure1< ParamType1, ClassType >::ThreadedProcedure1 (  ClassType *  src, ParamType1  p1, ClassThreadProcPtr  procPtr )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> VCF::ThreadedProcedure1< ParamType1, ClassType >::ThreadedProcedure1 (  ParamType1  p1  )  [inline, protected]

---

Member Function Documentation

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> Runnable* VCF::ThreadedProcedure1< ParamType1, ClassType >::getParams (   )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> Thread* VCF::ThreadedProcedure1< ParamType1, ClassType >::invoke (   )  [inline]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> virtual bool VCF::ThreadedProcedure1< 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 ParamType1, typename ClassType = NullClassType1<ParamType1>> virtual void VCF::ThreadedProcedure1< 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 ParamType1, typename ClassType = NullClassType1<ParamType1>> ClassProcPtr VCF::ThreadedProcedure1< ParamType1, ClassType >::classProcPtr_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> ClassThreadProcPtr VCF::ThreadedProcedure1< ParamType1, ClassType >::classThreadProcPtr_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> ClassType* VCF::ThreadedProcedure1< ParamType1, ClassType >::instancePtr_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> Runnable* VCF::ThreadedProcedure1< ParamType1, ClassType >::internalParams_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> ParamType1 VCF::ThreadedProcedure1< ParamType1, ClassType >::param1_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> ProcPtr VCF::ThreadedProcedure1< ParamType1, ClassType >::procPtr_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> ProcThreadPtr VCF::ThreadedProcedure1< ParamType1, ClassType >::procThreadPtr_ [protected]

template<typename ParamType1, typename ClassType = NullClassType1<ParamType1>> Thread* VCF::ThreadedProcedure1< ParamType1, ClassType >::runningThread_ [protected]

---

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

• vcf/FoundationKit/ThreadedFunctions.h

Comments or Suggestions?    License Information