vpr::ThreadRunFunctor< OBJ_TYPE > Class Template Reference

A variation on vpr::ThreadMemberFunctor that requires a class that implements the "runnable" concept. More...

#include <vpr/Thread/ThreadFunctor.h>

Inheritance diagram for vpr::ThreadRunFunctor< OBJ_TYPE >:

[legend]Collaboration diagram for vpr::ThreadRunFunctor< OBJ_TYPE >:

[legend]List of all members.

Public Types
typedef void(OBJ_TYPE::*)	FunPtr ()
Public Member Functions
	ThreadRunFunctor (OBJ_TYPE *theObject)
virtual	~ThreadRunFunctor ()
void	operator() (void *arg)
	Overloaded operator() used for invoking the function encapsulated by this object.
void	operator() ()
	Overloaded operator() used for invoking the function encapsulated by this object.
virtual void	setArg (void *arg)
	Sets the argument passed to the encapsulated function.
virtual bool	isValid ()
	Function to see if we have a valid functor.

---

Detailed Description

template<typename OBJ_TYPE>
class vpr::ThreadRunFunctor< OBJ_TYPE >

A variation on vpr::ThreadMemberFunctor that requires a class that implements the "runnable" concept.

That is, the class must have a run() method with the following signature: void run(). No argument will be passed to the runnable object when its run() method is invoked. Instead, it is up to the class author to ensure that the object has all information it needs to do its job before the thread is spawned.

Definition at line 173 of file ThreadFunctor.h.

---

Member Typedef Documentation

template<typename OBJ_TYPE>

typedef void(OBJ_TYPE::* ) vpr::ThreadRunFunctor< OBJ_TYPE >::FunPtr()

Definition at line 176 of file ThreadFunctor.h.

---

Constructor & Destructor Documentation

template<typename OBJ_TYPE>

vpr::ThreadRunFunctor< OBJ_TYPE >::ThreadRunFunctor

(

OBJ_TYPE *

theObject

)

[inline]

Definition at line 178 of file ThreadFunctor.h.

      : mObject(theObject)
      , mFunction(NULL)
   {
      mFunction = &OBJ_TYPE::run;
   }

template<typename OBJ_TYPE>

virtual vpr::ThreadRunFunctor< OBJ_TYPE >::~ThreadRunFunctor

(

)

[inline, virtual]

Definition at line 185 of file ThreadFunctor.h.

   {
      mObject   = (OBJ_TYPE*) 0xDEADBEEF;
//      mFunction = (FunPtr) 0xDEADBEEF;
   }

---

Member Function Documentation

template<typename OBJ_TYPE>

void vpr::ThreadRunFunctor< OBJ_TYPE >::operator()

(

void *

arg

)

[inline, virtual]

Overloaded operator() used for invoking the function encapsulated by this object.

This version takes an argument that is passed on to the function.

Parameters:

arg

The argument to be passed to the encapsulated function.

Implements vpr::BaseThreadFunctor.

Definition at line 191 of file ThreadFunctor.h.

   {
      boost::ignore_unused_variable_warning(arg);
      (mObject->*mFunction)();
   }

template<typename OBJ_TYPE>

void vpr::ThreadRunFunctor< OBJ_TYPE >::operator()

(

)

[inline, virtual]

Overloaded operator() used for invoking the function encapsulated by this object.

This version takes no argument and instead passes the argument given when this object was constructed.

Implements vpr::BaseThreadFunctor.

Definition at line 197 of file ThreadFunctor.h.

   {
      (mObject->*mFunction)();
   }

template<typename OBJ_TYPE>

virtual void vpr::ThreadRunFunctor< OBJ_TYPE >::setArg

(

void *

arg

)

[inline, virtual]

Sets the argument passed to the encapsulated function.

This will be used when the function is invoked through the overloaded operator().

Implements vpr::BaseThreadFunctor.

Definition at line 202 of file ThreadFunctor.h.

   {
      boost::ignore_unused_variable_warning(arg);
   }

template<typename OBJ_TYPE>

virtual bool vpr::ThreadRunFunctor< OBJ_TYPE >::isValid

(

)

[inline, virtual]

Function to see if we have a valid functor.

Implements vpr::BaseThreadFunctor.

Definition at line 207 of file ThreadFunctor.h.

References vprASSERT.

   {
      if ( (NULL == mObject) || ((OBJ_TYPE*) 0xDEADBEEF == mObject) )
      {
         vprASSERT(NULL != mObject);
         vprASSERT((OBJ_TYPE*)0xDEADBEEF != mObject);
         return false;
      }
      else if ( (NULL == mFunction) /* || ((FunPtr) 0xDEADBEEF == mFunction) */ )
      {
         return false;
      }
      else
      {
         return true;
      }
   }

---

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

• ThreadFunctor.h

---