Aria  2.8.0
ArGlobalFunctor2< P1, P2 > Class Template Reference

Functor for a global function with 2 parameters. More...

#include <ArFunctor.h>

Inherits ArFunctor2< P1, P2 >.

Public Member Functions

 ArGlobalFunctor2 ()
 Constructor.
 
 ArGlobalFunctor2 (void(*func)(P1, P2))
 Constructor - supply function pointer. More...
 
 ArGlobalFunctor2 (void(*func)(P1, P2), P1 p1)
 Constructor - supply function pointer, default parameters. More...
 
 ArGlobalFunctor2 (void(*func)(P1, P2), 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 ~ArGlobalFunctor2 ()
 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(* myFunc )(P1, P2)
 
P1 myP1
 
P2 myP2
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

template<class P1, class P2>
class ArGlobalFunctor2< P1, P2 >

Functor for a global function with 2 parameters.

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

◆ ArGlobalFunctor2() [1/3]

template<class P1 , class P2 >
ArGlobalFunctor2< P1, P2 >::ArGlobalFunctor2 ( void(*)(P1, P2)  func)
inline

Constructor - supply function pointer.

Parameters
funcglobal function pointer

◆ ArGlobalFunctor2() [2/3]

template<class P1 , class P2 >
ArGlobalFunctor2< P1, P2 >::ArGlobalFunctor2 ( void(*)(P1, P2)  func,
P1  p1 
)
inline

Constructor - supply function pointer, default parameters.

Parameters
funcglobal function pointer
p1default first parameter

◆ ArGlobalFunctor2() [3/3]

template<class P1 , class P2 >
ArGlobalFunctor2< P1, P2 >::ArGlobalFunctor2 ( void(*)(P1, P2)  func,
P1  p1,
P2  p2 
)
inline

Constructor - supply function pointer, default parameters.

Parameters
funcglobal function pointer
p1default first parameter
p2default second parameter

Member Function Documentation

◆ invoke() [1/2]

template<class P1 , class P2 >
virtual void ArGlobalFunctor2< P1, P2 >::invoke ( P1  p1)
inlinevirtual

Invokes the functor.

Parameters
p1first parameter

Implements ArFunctor2< P1, P2 >.

◆ invoke() [2/2]

template<class P1 , class P2 >
virtual void ArGlobalFunctor2< P1, P2 >::invoke ( P1  p1,
P2  p2 
)
inlinevirtual

Invokes the functor.

Parameters
p1first parameter
p2second parameter

Implements ArFunctor2< P1, P2 >.

◆ setP1()

template<class P1 , class P2 >
virtual void ArGlobalFunctor2< P1, P2 >::setP1 ( P1  p1)
inlinevirtual

Set the default parameter.

Parameters
p1default first parameter

◆ setP2()

template<class P1 , class P2 >
virtual void ArGlobalFunctor2< P1, P2 >::setP2 ( P2  p2)
inlinevirtual

Set the default 2nd parameter.

Parameters
p2default second parameter

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