Aria  2.8.0
ArGlobalRetFunctor< Ret > Class Template Reference

Functor for a global function with return value. More...

#include <ArFunctor.h>

Inherits ArRetFunctor< Ret >.

Public Member Functions

 ArGlobalRetFunctor ()
 Constructor.
 
 ArGlobalRetFunctor (Ret(*func)(void))
 Constructor - supply function pointer. More...
 
virtual Ret invokeR (void)
 Invokes the functor with return value.
 
virtual ~ArGlobalRetFunctor ()
 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 )(void)
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

template<class Ret>
class ArGlobalRetFunctor< Ret >

Functor for a global function with return value.

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

◆ ArGlobalRetFunctor()

template<class Ret>
ArGlobalRetFunctor< Ret >::ArGlobalRetFunctor ( Ret(*)(void)  func)
inline

Constructor - supply function pointer.

Parameters
funcglobal function pointer

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