Main Page   Class Hierarchy   Compound List   Compound Members  

ArGlobalRetFunctor3 Class Template Reference

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

#include <ArFunctor.h>

Inheritance diagram for ArGlobalRetFunctor3::

ArRetFunctor3 ArRetFunctor ArFunctor List of all members.

Public Methods

 ArGlobalRetFunctor3 (void)
 Constructor.

 ArGlobalRetFunctor3 (Ret(*func)(P1, P2, P3))
 Constructor - supply function pointer. More...

 ArGlobalRetFunctor3 (Ret(*func)(P1, P2, P3), P1 p1)
 Constructor - supply function pointer, default parameters. More...

 ArGlobalRetFunctor3 (Ret(*func)(P1, P2, P3), P1 p1, P2 p2)
 Constructor - supply function pointer, default parameters. More...

 ArGlobalRetFunctor3 (Ret(*func)(P1, P2, P3), P1 p1, P2 p2, P3 p3)
 Constructor - supply function pointer, default parameters. More...

virtual ~ArGlobalRetFunctor3 (void)
 Destructor.

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 Ret invokeR (P1 p1, P2 p2, P3 p3)
 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 void setP3 (P2 p3)
 Set the default third parameter. More...


Detailed Description

template<class Ret, class P1, class P2, class P3>
class ArGlobalRetFunctor3< Ret, P1, P2, P3 >

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

template<class Ret, class P1, class P2, class P3>
ArGlobalRetFunctor3< Ret, P1, P2, P3 >::ArGlobalRetFunctor3 Ret(*    func)(P1, P2, P3) [inline]
 

Constructor - supply function pointer.

Parameters:
func  global function pointer

template<class Ret, class P1, class P2, class P3>
ArGlobalRetFunctor3< Ret, P1, P2, P3 >::ArGlobalRetFunctor3 Ret(*    func)(P1, P2, P3),
P1    p1
[inline]
 

Constructor - supply function pointer, default parameters.

Parameters:
func  global function pointer
p1  default first parameter

template<class Ret, class P1, class P2, class P3>
ArGlobalRetFunctor3< Ret, P1, P2, P3 >::ArGlobalRetFunctor3 Ret(*    func)(P1, P2, P3),
P1    p1,
P2    p2
[inline]
 

Constructor - supply function pointer, default parameters.

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

template<class Ret, class P1, class P2, class P3>
ArGlobalRetFunctor3< Ret, P1, P2, P3 >::ArGlobalRetFunctor3 Ret(*    func)(P1, P2, P3),
P1    p1,
P2    p2,
P3    p3
[inline]
 

Constructor - supply function pointer, default parameters.

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


Member Function Documentation

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR P1    p1,
P2    p2,
P3    p3
[inline, virtual]
 

Invokes the functor with return value.

Parameters:
p1  first parameter
p2  second parameter
p3  third parameter

Reimplemented from ArRetFunctor3.

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR P1    p1,
P2    p2
[inline, virtual]
 

Invokes the functor with return value.

Parameters:
p1  first parameter
p2  second parameter

Reimplemented from ArRetFunctor3.

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR P1    p1 [inline, virtual]
 

Invokes the functor with return value.

Parameters:
p1  first parameter

Reimplemented from ArRetFunctor3.

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP1 P1    p1 [inline, virtual]
 

Set the default parameter.

Parameters:
p1  default first parameter

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP2 P2    p2 [inline, virtual]
 

Set the default 2nd parameter.

Parameters:
p2  default second parameter

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP3 P2    p3 [inline, virtual]
 

Set the default third parameter.

Parameters:
p3  default third parameter


The documentation for this class was generated from the following file:
Generated on Tue Nov 12 17:43:56 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001