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

Specialisation for free nullary functions that return void. More...

#include <function_objects.hpp>

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

Public Member Functions

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

Private Attributes

void(* free_function )()
 

Additional Inherited Members

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

Detailed Description

Specialisation for free nullary functions that return void.

Specialisation for free nullary functions that return void.

See also
NullaryFreeFunction, generateFunctionObject, FunctionObjects.

Definition at line 166 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ NullaryFreeFunction()

ecl::NullaryFreeFunction< void >::NullaryFreeFunction ( void(*)()  function)
inline

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

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

Parameters
function: the global/static function.

Definition at line 176 of file function_objects.hpp.

◆ ~NullaryFreeFunction()

virtual ecl::NullaryFreeFunction< void >::~NullaryFreeFunction ( )
inlinevirtual

Definition at line 178 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

void ecl::NullaryFreeFunction< void >::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 187 of file function_objects.hpp.

Member Data Documentation

◆ free_function

void(* ecl::NullaryFreeFunction< void >::free_function) ()
private

Definition at line 190 of file function_objects.hpp.


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


ecl_utilities
Author(s): Daniel Stonier
autogenerated on Wed Mar 2 2022 00:16:32