ArGlobalRetFunctor2< Ret, P1, P2 > Class Template Reference

Functor for a global function with 2 parameters and return value. More...

#include <ArFunctor.h>

Inherits ArRetFunctor2< Ret, P1, P2 >.

Public Member Functions
	ArGlobalRetFunctor2 ()
	Constructor.
	ArGlobalRetFunctor2 (Ret(*func)(P1, P2))
	Constructor - supply function pointer. More...
	ArGlobalRetFunctor2 (Ret(*func)(P1, P2), P1 p1)
	Constructor - supply function pointer, default parameters. More...
	ArGlobalRetFunctor2 (Ret(*func)(P1, P2), P1 p1, P2 p2)
	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 Ret	invokeR (P1 p1, P2 p2)
	Invokes the functor with return value. More...
virtual void	setP1 (P1 p1)
	Set the default parameter. More...
virtual void	setP2 (P2 p2)
	Set the default 2nd parameter. More...
virtual	~ArGlobalRetFunctor2 ()
	Destructor.
Public Member Functions inherited from ArRetFunctor2< Ret, P1, P2 >
virtual	~ArRetFunctor2 ()
	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(*	myFunc )(P1, P2)
P1	myP1
P2	myP2
Protected Attributes inherited from ArFunctor
std::string	myName

Detailed Description

template<class Ret, class P1, class P2>
class ArGlobalRetFunctor2< Ret, P1, P2 >

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

This is a class for global functions which take 2 parameters and return a value. This ties a C style function pointer into the functor class hierarchy as a convience. Code that has a reference to this class and treat it as an ArFunctor can use it like any other functor.

For an overall description of functors, see ArFunctor.

Constructor & Destructor Documentation

ArGlobalRetFunctor2() [1/3]

template<class Ret, class P1, class P2>

ArGlobalRetFunctor2< Ret, P1, P2 >::ArGlobalRetFunctor2 ( Ret(*)(P1, P2)  func )

inline

Constructor - supply function pointer.

Parameters

func	global function pointer

ArGlobalRetFunctor2() [2/3]

template<class Ret, class P1, class P2>

ArGlobalRetFunctor2< Ret, P1, P2 >::ArGlobalRetFunctor2 ( Ret(*)(P1, P2)  func, P1  p1  )

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter

ArGlobalRetFunctor2() [3/3]

template<class Ret, class P1, class P2>

ArGlobalRetFunctor2< Ret, P1, P2 >::ArGlobalRetFunctor2 ( Ret(*)(P1, P2)  func, P1  p1, P2  p2  )

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter
p2	default second parameter

Member Function Documentation

invokeR() [1/2]

template<class Ret, class P1, class P2>

virtual Ret ArGlobalRetFunctor2< Ret, P1, P2 >::invokeR ( P1  p1 )

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter

Implements ArRetFunctor2< Ret, P1, P2 >.

invokeR() [2/2]

template<class Ret, class P1, class P2>

virtual Ret ArGlobalRetFunctor2< Ret, P1, P2 >::invokeR ( P1  p1, P2  p2  )

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter
p2	second parameter

Implements ArRetFunctor2< Ret, P1, P2 >.

setP1()

template<class Ret, class P1, class P2>

virtual void ArGlobalRetFunctor2< Ret, P1, P2 >::setP1 ( P1  p1 )

inlinevirtual

Set the default parameter.

Parameters

p1	default first parameter

setP2()

template<class Ret, class P1, class P2>

virtual void ArGlobalRetFunctor2< Ret, P1, P2 >::setP2 ( P2  p2 )

inlinevirtual

Set the default 2nd parameter.

Parameters

p2	default second parameter

---

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

• ArFunctor.h