Aria  2.8.0
ArFunctorC< T > Class Template Reference

Functor for a member function. More...

#include <ArFunctor.h>

Inherits ArFunctor.

Public Member Functions

 ArFunctorC ()
 Constructor.
 
 ArFunctorC (T &obj, void(T::*func)(void))
 Constructor - supply function pointer. More...
 
 ArFunctorC (T *obj, void(T::*func)(void))
 Constructor - supply function pointer. More...
 
virtual void invoke (void)
 Invokes the functor.
 
virtual void setThis (T *obj)
 Set the 'this' pointer. More...
 
virtual void setThis (T &obj)
 Set the 'this' pointer. More...
 
virtual ~ArFunctorC ()
 Destructor.
 
- Public Member Functions inherited from ArFunctor
virtual const char * getName (void)
 Gets the name of the functor.
 
virtual void setName (const char *name)
 Sets the name of the functor.
 
virtual void setNameVar (const char *name,...)
 Sets the name of the functor with formatting. More...
 
virtual ~ArFunctor ()
 Destructor.
 

Protected Attributes

void(T::* myFunc )(void)
 
T * myObj
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

template<class T>
class ArFunctorC< T >

Functor for a member function.

This is a class for member functions. This class contains the knowledge on how to call a member function on a particular instance of a class. This class should be instantiated by code that wishes to pass off a functor to another piece of code.

For an overall description of functors, see ArFunctor.

Examples:
functorExample.cpp, lineFinderExample.cpp, and triangleDriveToActionExample.cpp.

Constructor & Destructor Documentation

◆ ArFunctorC() [1/2]

template<class T>
ArFunctorC< T >::ArFunctorC ( T &  obj,
void(T::*)(void)  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcmember function pointer

◆ ArFunctorC() [2/2]

template<class T>
ArFunctorC< T >::ArFunctorC ( T *  obj,
void(T::*)(void)  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcmember function pointer

Member Function Documentation

◆ setThis() [1/2]

template<class T>
virtual void ArFunctorC< T >::setThis ( T *  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

◆ setThis() [2/2]

template<class T>
virtual void ArFunctorC< T >::setThis ( T &  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

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