ArConstFunctor2C< T, P1, P2 > Class Template Reference

Functor for a const member function with 2 parameters. More...

#include <ArFunctor.h>

Inherits ArFunctor2< P1, P2 >.

Public Member Functions
	ArConstFunctor2C ()
	Constructor.
	ArConstFunctor2C (T &obj, void(T::*func)(P1, P2) const)
	Constructor - supply function pointer. More...
	ArConstFunctor2C (T &obj, void(T::*func)(P1, P2) const, P1 p1)
	Constructor - supply function pointer, default parameters. More...
	ArConstFunctor2C (T &obj, void(T::*func)(P1, P2) const, P1 p1, P2 p2)
	Constructor - supply function pointer, default parameters. More...
	ArConstFunctor2C (T *obj, void(T::*func)(P1, P2) const)
	Constructor - supply function pointer. More...
	ArConstFunctor2C (T *obj, void(T::*func)(P1, P2) const, P1 p1)
	Constructor - supply function pointer, default parameters. More...
	ArConstFunctor2C (T *obj, void(T::*func)(P1, P2) const, P1 p1, P2 p2)
	Constructor - supply function pointer, default parameters. More...
virtual void	invoke (void)
	Invokes the functor.
virtual void	invoke (P1 p1)
	Invokes the functor. More...
virtual void	invoke (P1 p1, P2 p2)
	Invokes the functor. More...
virtual void	setP1 (P1 p1)
	Set the default parameter. More...
virtual void	setP2 (P2 p2)
	Set the default 2nd parameter. More...
virtual void	setThis (T *obj)
	Set the 'this' pointer. More...
virtual void	setThis (T &obj)
	Set the 'this' pointer. More...
virtual	~ArConstFunctor2C ()
	Destructor.
Public Member Functions inherited from ArFunctor2< P1, P2 >
virtual	~ArFunctor2 ()
	Destructor.
Public Member Functions inherited from ArFunctor1< P1 >
virtual	~ArFunctor1 ()
	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 )(P1, P2) const
T *	myObj
P1	myP1
P2	myP2
Protected Attributes inherited from ArFunctor
std::string	myName

Detailed Description

template<class T, class P1, class P2>
class ArConstFunctor2C< T, P1, P2 >

Functor for a const member function with 2 parameters.

This is a class for const member functions which take 2 parameters. This class contains the knowledge on how to call a const 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.

Constructor & Destructor Documentation

ArConstFunctor2C() [1/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T &  obj, void(T::*)(P1, P2) const  func  )

inline

Constructor - supply function pointer.

Parameters

obj	object to call function on
func	const member function pointer

ArConstFunctor2C() [2/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T &  obj, void(T::*)(P1, P2) const  func, P1  p1  )

inline

Constructor - supply function pointer, default parameters.

Parameters

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

ArConstFunctor2C() [3/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T &  obj, void(T::*)(P1, P2) const  func, P1  p1, P2  p2  )

inline

Constructor - supply function pointer, default parameters.

Parameters

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

ArConstFunctor2C() [4/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T *  obj, void(T::*)(P1, P2) const  func  )

inline

Constructor - supply function pointer.

Parameters

obj	object to call function on
func	const member function pointer

ArConstFunctor2C() [5/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T *  obj, void(T::*)(P1, P2) const  func, P1  p1  )

inline

Constructor - supply function pointer, default parameters.

Parameters

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

ArConstFunctor2C() [6/6]

template<class T , class P1 , class P2 >

ArConstFunctor2C< T, P1, P2 >::ArConstFunctor2C ( T *  obj, void(T::*)(P1, P2) const  func, P1  p1, P2  p2  )

inline

Constructor - supply function pointer, default parameters.

Parameters

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

Member Function Documentation

invoke() [1/2]

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::invoke ( P1  p1 )

inlinevirtual

Invokes the functor.

Parameters

p1	first parameter

Implements ArFunctor2< P1, P2 >.

invoke() [2/2]

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::invoke ( P1  p1, P2  p2  )

inlinevirtual

Invokes the functor.

Parameters

p1	first parameter
p2	second parameter

Implements ArFunctor2< P1, P2 >.

setP1()

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::setP1 ( P1  p1 )

inlinevirtual

Set the default parameter.

Parameters

p1	default first parameter

setP2()

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::setP2 ( P2  p2 )

inlinevirtual

Set the default 2nd parameter.

Parameters

p2	default second parameter

setThis() [1/2]

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::setThis ( T *  obj )

inlinevirtual

Set the 'this' pointer.

Parameters

obj	the 'this' pointer

setThis() [2/2]

template<class T , class P1 , class P2 >

virtual void ArConstFunctor2C< T, P1, P2 >::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