ArRetFunctor1C< Ret, T, P1 > Class Template Reference

Functor for a member function with return value and 1 parameter. More...

#include <ArFunctor.h>

Inherits ArRetFunctor1< Ret, P1 >.

Public Member Functions
	ArRetFunctor1C ()
	Constructor.
	ArRetFunctor1C (T &obj, Ret(T::*func)(P1))
	Constructor - supply function pointer. More...
	ArRetFunctor1C (T &obj, Ret(T::*func)(P1), P1 p1)
	Constructor - supply function pointer, default parameters. More...
	ArRetFunctor1C (T *obj, Ret(T::*func)(P1))
	Constructor - supply function pointer. More...
	ArRetFunctor1C (T *obj, Ret(T::*func)(P1), P1 p1)
	Constructor - supply function pointer, default parameters. More...
virtual Ret	invokeR (void)
	Invokes the functor with return value.
virtual Ret	invokeR (P1 p1)
	Invokes the functor with return value. More...
virtual void	setP1 (P1 p1)
	Set the default parameter. More...
virtual void	setThis (T *obj)
	Set the 'this' pointer. More...
virtual void	setThis (T &obj)
	Set the 'this' pointer. More...
virtual	~ArRetFunctor1C ()
	Destructor.
Public Member Functions inherited from ArRetFunctor1< Ret, P1 >
virtual	~ArRetFunctor1 ()
	Destructor.
Public Member Functions inherited from ArRetFunctor< Ret >
virtual void	invoke (void)
	Invokes the functor.
virtual	~ArRetFunctor ()
	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
Ret(T::*	myFunc )(P1)
T *	myObj
P1	myP1
Protected Attributes inherited from ArFunctor
std::string	myName

Detailed Description

template<class Ret, class T, class P1>
class ArRetFunctor1C< Ret, T, P1 >

Functor for a member function with return value and 1 parameter.

This is a class for member functions which take 1 parameter and return a value. 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, gpsRobotTaskExample.cpp, and gyroExample.cpp.

Constructor & Destructor Documentation

ArRetFunctor1C() [1/4]

template<class Ret, class T, class P1>

ArRetFunctor1C< Ret, T, P1 >::ArRetFunctor1C ( T &  obj, Ret(T::*)(P1)  func  )

inline

Constructor - supply function pointer.

Parameters

obj	object to call function on
func	member function pointer

ArRetFunctor1C() [2/4]

template<class Ret, class T, class P1>

ArRetFunctor1C< Ret, T, P1 >::ArRetFunctor1C ( T &  obj, Ret(T::*)(P1)  func, P1  p1  )

inline

Constructor - supply function pointer, default parameters.

Parameters

obj	object to call function on
func	member function pointer
p1	default first parameter

ArRetFunctor1C() [3/4]

template<class Ret, class T, class P1>

ArRetFunctor1C< Ret, T, P1 >::ArRetFunctor1C ( T *  obj, Ret(T::*)(P1)  func  )

inline

Constructor - supply function pointer.

Parameters

obj	object to call function on
func	member function pointer

ArRetFunctor1C() [4/4]

template<class Ret, class T, class P1>

ArRetFunctor1C< Ret, T, P1 >::ArRetFunctor1C ( T *  obj, Ret(T::*)(P1)  func, P1  p1  )

inline

Constructor - supply function pointer, default parameters.

Parameters

obj	object to call function on
func	member function pointer
p1	default first parameter

Member Function Documentation

invokeR()

template<class Ret, class T, class P1>

virtual Ret ArRetFunctor1C< Ret, T, P1 >::invokeR ( P1  p1 )

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter

Implements ArRetFunctor1< Ret, P1 >.

setP1()

template<class Ret, class T, class P1>

virtual void ArRetFunctor1C< Ret, T, P1 >::setP1 ( P1  p1 )

inlinevirtual

Set the default parameter.

Parameters

p1	default first parameter

setThis() [1/2]

template<class Ret, class T, class P1>

virtual void ArRetFunctor1C< Ret, T, P1 >::setThis ( T *  obj )

inlinevirtual

Set the 'this' pointer.

Parameters

obj	the 'this' pointer

setThis() [2/2]

template<class Ret, class T, class P1>

virtual void ArRetFunctor1C< Ret, T, P1 >::setThis ( T &  obj )

inlinevirtual

Set the 'this' pointer.

Parameters

obj	the 'this' pointer

---

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

• ArFunctor.h