Aria  2.8.0
ArConstRetFunctorC< Ret, T > Class Template Reference

Functor for a const member function with return value. More...

#include <ArFunctor.h>

Inherits ArRetFunctor< Ret >.

Public Member Functions

 ArConstRetFunctorC ()
 Constructor.
 
 ArConstRetFunctorC (T &obj, Ret(T::*func)(void) const)
 Constructor - supply function pointer. More...
 
 ArConstRetFunctorC (T *obj, Ret(T::*func)(void) const)
 Constructor - supply function pointer. More...
 
virtual Ret invokeR (void)
 Invokes the functor with return value.
 
virtual void setThis (T *obj)
 Set the 'this' pointer. More...
 
virtual void setThis (T &obj)
 Set the 'this' pointer. More...
 
virtual ~ArConstRetFunctorC ()
 Destructor - supply function pointer.
 
- 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(T::* myFunc )(void) const
 
T * myObj
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

template<class Ret, class T>
class ArConstRetFunctorC< Ret, T >

Functor for a const member function with return value.

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

Constructor & Destructor Documentation

◆ ArConstRetFunctorC() [1/2]

template<class Ret , class T >
ArConstRetFunctorC< Ret, T >::ArConstRetFunctorC ( T &  obj,
Ret(T::*)(void) const  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcconst member function pointer

◆ ArConstRetFunctorC() [2/2]

template<class Ret , class T >
ArConstRetFunctorC< Ret, T >::ArConstRetFunctorC ( T *  obj,
Ret(T::*)(void) const  func 
)
inline

Constructor - supply function pointer.

Parameters
objobject to call function on
funcconst member function pointer

Member Function Documentation

◆ setThis() [1/2]

template<class Ret , class T >
virtual void ArConstRetFunctorC< Ret, T >::setThis ( T *  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

◆ setThis() [2/2]

template<class Ret , class T >
virtual void ArConstRetFunctorC< Ret, T >::setThis ( T &  obj)
inlinevirtual

Set the 'this' pointer.

Parameters
objthe 'this' pointer

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