Public Member Functions | Private Attributes | List of all members
ecl::NullaryFreeFunction< R > Class Template Reference

Nullary function object for void global/static functions. More...

#include <function_objects.hpp>

Inheritance diagram for ecl::NullaryFreeFunction< R >:
Inheritance graph
[legend]

Public Member Functions

 NullaryFreeFunction (R(*function)())
 Nullary function object constructor for global/static functions with no args. More...
 
operator() ()
 This ensures any children objects are deleted correctly. More...
 
virtual ~NullaryFreeFunction ()
 
- Public Member Functions inherited from ecl::NullaryFunction< void >
virtual ~NullaryFunction ()
 

Private Attributes

R(* free_function )()
 

Additional Inherited Members

- Public Types inherited from ecl::NullaryFunction< void >
typedef void result_type
 The result type. More...
 

Detailed Description

template<typename R = void>
class ecl::NullaryFreeFunction< R >

Nullary function object for void global/static functions.

Creates a function object from a void global/static function.

Template Parameters
R: the return type.
See also
ecl::utilities::NullaryFreeFunction<void>, generateFunctionObject, FunctionObjects.

Definition at line 132 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ NullaryFreeFunction()

template<typename R = void>
ecl::NullaryFreeFunction< R >::NullaryFreeFunction ( R(*)()  function)
inline

Nullary function object constructor for global/static functions with no args.

Accepts a global/static function with no args and builds the function object around it.

Parameters
function: the global/static function.

Definition at line 144 of file function_objects.hpp.

◆ ~NullaryFreeFunction()

template<typename R = void>
virtual ecl::NullaryFreeFunction< R >::~NullaryFreeFunction ( )
inlinevirtual

Definition at line 145 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename R = void>
R ecl::NullaryFreeFunction< R >::operator() ( )
inlinevirtual

This ensures any children objects are deleted correctly.

A nullary function object call.

Redirects the nullary function object call to the composited global/static function.

Returns
R : the function's return value.

Implements ecl::NullaryFunction< void >.

Definition at line 154 of file function_objects.hpp.

Member Data Documentation

◆ free_function

template<typename R = void>
R(* ecl::NullaryFreeFunction< R >::free_function) ()
private

Definition at line 157 of file function_objects.hpp.


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


ecl_utilities
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:13