Aria  2.8.0
ArFunctor1C< T, P1 > Class Template Reference

Functor for a member function with 1 parameter. More...

#include <ArFunctor.h>

Inherits ArFunctor1< P1 >.

Public Member Functions

 ArFunctor1C ()
 Constructor.
 
 ArFunctor1C (T &obj, void(T::*func)(P1))
 Constructor - supply function pointer. More...
 
 ArFunctor1C (T &obj, void(T::*func)(P1), P1 p1)
 Constructor - supply function pointer, default parameters. More...
 
 ArFunctor1C (T *obj, void(T::*func)(P1))
 Constructor - supply function pointer. More...
 
 ArFunctor1C (T *obj, void(T::*func)(P1), P1 p1)
 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 setP1 (P1 p1)
 Set the default parameter. More...
 
virtual void setThis (T *obj)
 Set the 'this' pointer. More...
 
virtual void setThis (T &obj)
 Set the 'this' pointer. More...
 
virtual ~ArFunctor1C ()
 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)
 
T * myObj
 
P1 myP1
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

template<class T, class P1>
class ArFunctor1C< T, P1 >

Functor for a member function with 1 parameter.

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

Examples:
functorExample.cpp, and gyroExample.cpp.

Constructor & Destructor Documentation

◆ ArFunctor1C() [1/4]

template<class T, class P1>
ArFunctor1C< T, P1 >::ArFunctor1C ( T &  obj,
void(T::*)(P1)  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcmember function pointer

◆ ArFunctor1C() [2/4]

template<class T, class P1>
ArFunctor1C< T, P1 >::ArFunctor1C ( T &  obj,
void(T::*)(P1)  func,
P1  p1 
)
inline

Constructor - supply function pointer, default parameters.

Parameters
objobject to call function on
funcmember function pointer
p1default first parameter

◆ ArFunctor1C() [3/4]

template<class T, class P1>
ArFunctor1C< T, P1 >::ArFunctor1C ( T *  obj,
void(T::*)(P1)  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcmember function pointer

◆ ArFunctor1C() [4/4]

template<class T, class P1>
ArFunctor1C< T, P1 >::ArFunctor1C ( T *  obj,
void(T::*)(P1)  func,
P1  p1 
)
inline

Constructor - supply function pointer, default parameters.

Parameters
objobject to call function on
funcmember function pointer
p1default first parameter

Member Function Documentation

◆ invoke()

template<class T, class P1>
virtual void ArFunctor1C< T, P1 >::invoke ( P1  p1)
inlinevirtual

Invokes the functor.

Parameters
p1first parameter

Implements ArFunctor1< P1 >.

◆ setP1()

template<class T, class P1>
virtual void ArFunctor1C< T, P1 >::setP1 ( P1  p1)
inlinevirtual

Set the default parameter.

Parameters
p1default first parameter

◆ setThis() [1/2]

template<class T, class P1>
virtual void ArFunctor1C< T, P1 >::setThis ( T *  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

◆ setThis() [2/2]

template<class T, class P1>
virtual void ArFunctor1C< T, P1 >::setThis ( T &  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

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