Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages | Examples

ArRetFunctor2C< Ret, T, P1, P2 > Class Template Reference

#include <ArFunctor.h>

Inheritance diagram for ArRetFunctor2C< Ret, T, P1, P2 >:

ArRetFunctor2< Ret, P1, P2 > ArRetFunctor1< Ret, P1 > ArRetFunctor< Ret > ArFunctor List of all members.

Detailed Description

template<class Ret, class T, class P1, class P2>
class ArRetFunctor2C< Ret, T, P1, P2 >

Functor for a member function with return value and 2 parameters.

This is a class for member functions which take 2 parameters 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.

Definition at line 2113 of file ArFunctor.h.

Public Member Functions

 ArRetFunctor2C (T *obj, Ret(T::*func)(P1, P2), P1 p1, P2 p2)
 Constructor - supply function pointer, default parameters.
 ArRetFunctor2C (T *obj, Ret(T::*func)(P1, P2), P1 p1)
 Constructor - supply function pointer, default parameters.
 ArRetFunctor2C (T *obj, Ret(T::*func)(P1, P2))
 Constructor - supply function pointer.
 ArRetFunctor2C (T &obj, Ret(T::*func)(P1, P2), P1 p1, P2 p2)
 Constructor - supply function pointer, default parameters.
 ArRetFunctor2C (T &obj, Ret(T::*func)(P1, P2), P1 p1)
 Constructor - supply function pointer, default parameters.
 ArRetFunctor2C (T &obj, Ret(T::*func)(P1, P2))
 Constructor - supply function pointer.
 ArRetFunctor2C ()
 Constructor.
virtual Ret invokeR (P1 p1, P2 p2)
 Invokes the functor with return value.
virtual Ret invokeR (P1 p1)
 Invokes the functor with return value.
virtual Ret invokeR (void)
 Invokes the functor with return value.
virtual void setP1 (P1 p1)
 Set the default parameter.
virtual void setP2 (P2 p2)
 Set the default 2nd parameter.
virtual void setThis (T &obj)
 Set the 'this' pointer.
virtual void setThis (T *obj)
 Set the 'this' pointer.
virtual ~ArRetFunctor2C ()
 Destructor.

Protected Attributes

Ret(T::* myFunc )(P1, P2)
T * myObj
P1 myP1
P2 myP2

Constructor & Destructor Documentation

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T &  obj,
Ret(T::*)(P1, P2)  func
)  [inline]
 

Constructor - supply function pointer.

Parameters:
func member function pointer

Definition at line 2124 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T &  obj,
Ret(T::*)(P1, P2)  func,
P1  p1
)  [inline]
 

Constructor - supply function pointer, default parameters.

Parameters:
func member function pointer
p1 default first parameter

Definition at line 2132 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T &  obj,
Ret(T::*)(P1, P2)  func,
P1  p1,
P2  p2
)  [inline]
 

Constructor - supply function pointer, default parameters.

Parameters:
func member function pointer
p1 default first parameter
p2 default second parameter

Definition at line 2141 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T *  obj,
Ret(T::*)(P1, P2)  func
)  [inline]
 

Constructor - supply function pointer.

Parameters:
func member function pointer

Definition at line 2148 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T *  obj,
Ret(T::*)(P1, P2)  func,
P1  p1
)  [inline]
 

Constructor - supply function pointer, default parameters.

Parameters:
func member function pointer
p1 default first parameter

Definition at line 2156 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
ArRetFunctor2C< Ret, T, P1, P2 >::ArRetFunctor2C (  T *  obj,
Ret(T::*)(P1, P2)  func,
P1  p1,
P2  p2
)  [inline]
 

Constructor - supply function pointer, default parameters.

Parameters:
func member function pointer
p1 default first parameter
p2 default second parameter

Definition at line 2165 of file ArFunctor.h.

Member Function Documentation

template<class Ret, class T, class P1, class P2>
virtual Ret ArRetFunctor2C< Ret, T, P1, P2 >::invokeR (  P1  p1,
P2  p2
)  [inline, virtual]
 

Invokes the functor with return value.

Parameters:
p1 first parameter
p2 second parameter

Implements ArRetFunctor2< Ret, P1, P2 >.

Definition at line 2185 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
virtual Ret ArRetFunctor2C< Ret, T, P1, P2 >::invokeR (  P1  p1  )  [inline, virtual]
 

Invokes the functor with return value.

Parameters:
p1 first parameter

Implements ArRetFunctor2< Ret, P1, P2 >.

Definition at line 2178 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
virtual void ArRetFunctor2C< Ret, T, P1, P2 >::setP1 (  P1  p1  )  [inline, virtual]
 

Set the default parameter.

Parameters:
p1 default first parameter

Definition at line 2203 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
virtual void ArRetFunctor2C< Ret, T, P1, P2 >::setP2 (  P2  p2  )  [inline, virtual]
 

Set the default 2nd parameter.

Parameters:
p2 default second parameter

Definition at line 2209 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
virtual void ArRetFunctor2C< Ret, T, P1, P2 >::setThis (  T &  obj  )  [inline, virtual]
 

Set the 'this' pointer.

Parameters:
obj the 'this' pointer

Definition at line 2197 of file ArFunctor.h.

template<class Ret, class T, class P1, class P2>
virtual void ArRetFunctor2C< Ret, T, P1, P2 >::setThis (  T *  obj  )  [inline, virtual]
 

Set the 'this' pointer.

Parameters:
obj the 'this' pointer

Definition at line 2191 of file ArFunctor.h.

The documentation for this class was generated from the following file:
Generated on Tue Feb 20 10:51:44 2007 for Aria by  doxygen 1.4.0