Aria  2.8.0
ArGlobalRetFunctor3< Ret, P1, P2, P3 > Class Template Reference

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

#include <ArFunctor.h>

Inherits ArRetFunctor3< Ret, P1, P2, P3 >.

Public Member Functions

 ArGlobalRetFunctor3 ()
 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 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 (P3 p3)
 Set the default third parameter. More...
 
virtual ~ArGlobalRetFunctor3 ()
 Destructor.
 
- Public Member Functions inherited from ArRetFunctor3< Ret, P1, P2, P3 >
virtual ~ArRetFunctor3 ()
 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, P3)
 
P1 myP1
 
P2 myP2
 
P3 myP3
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

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

◆ ArGlobalRetFunctor3() [1/4]

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

Constructor - supply function pointer.

Parameters
funcglobal function pointer

◆ ArGlobalRetFunctor3() [2/4]

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

Constructor - supply function pointer, default parameters.

Parameters
funcglobal function pointer
p1default first parameter

◆ ArGlobalRetFunctor3() [3/4]

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

Constructor - supply function pointer, default parameters.

Parameters
funcglobal function pointer
p1default first parameter
p2default second parameter

◆ ArGlobalRetFunctor3() [4/4]

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

Constructor - supply function pointer, default parameters.

Parameters
funcglobal function pointer
p1default first parameter
p2default second parameter
p3default third parameter

Member Function Documentation

◆ invokeR() [1/3]

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR ( P1  p1)
inlinevirtual

Invokes the functor with return value.

Parameters
p1first parameter

Implements ArRetFunctor3< Ret, P1, P2, P3 >.

◆ invokeR() [2/3]

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR ( P1  p1,
P2  p2 
)
inlinevirtual

Invokes the functor with return value.

Parameters
p1first parameter
p2second parameter

Implements ArRetFunctor3< Ret, P1, P2, P3 >.

◆ invokeR() [3/3]

template<class Ret, class P1, class P2, class P3>
virtual Ret ArGlobalRetFunctor3< Ret, P1, P2, P3 >::invokeR ( P1  p1,
P2  p2,
P3  p3 
)
inlinevirtual

Invokes the functor with return value.

Parameters
p1first parameter
p2second parameter
p3third parameter

Implements ArRetFunctor3< Ret, P1, P2, P3 >.

◆ setP1()

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP1 ( P1  p1)
inlinevirtual

Set the default parameter.

Parameters
p1default first parameter

◆ setP2()

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP2 ( P2  p2)
inlinevirtual

Set the default 2nd parameter.

Parameters
p2default second parameter

◆ setP3()

template<class Ret, class P1, class P2, class P3>
virtual void ArGlobalRetFunctor3< Ret, P1, P2, P3 >::setP3 ( P3  p3)
inlinevirtual

Set the default third parameter.

Parameters
p3default third parameter

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