Public Member Functions | Private Attributes | List of all members
ecl::UnaryFreeFunction< A, void > Class Template Reference

Specialisations for free unary functions with no return type. More...

#include <function_objects.hpp>

Inheritance diagram for ecl::UnaryFreeFunction< A, void >:
Inheritance graph
[legend]

Public Member Functions

void operator() (A a)
 This ensures any children objects are deleted correctly. More...
 
 UnaryFreeFunction (void(*function)(A))
 Unary function object constructor for global/static unary functions with no return type. More...
 
virtual ~UnaryFreeFunction ()
 
- Public Member Functions inherited from ecl::UnaryFunction< A, void >
virtual ~UnaryFunction ()
 

Private Attributes

void(* free_function )(A)
 

Additional Inherited Members

- Public Types inherited from ecl::UnaryFunction< A, void >
typedef A argument_type
 The first argument type. More...
 
typedef void result_type
 The result type. More...
 

Detailed Description

template<typename A>
class ecl::UnaryFreeFunction< A, void >

Specialisations for free unary functions with no return type.

Specialisations for free unary functions with no return type.

Template Parameters
A: the argument type.
See also
ecl::utilities::UnaryFreeFunction, generateFunctionObject, FunctionObjects.

Definition at line 244 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ UnaryFreeFunction()

template<typename A >
ecl::UnaryFreeFunction< A, void >::UnaryFreeFunction ( void(*)(A)  function)
inline

Unary function object constructor for global/static unary functions with no return type.

Accepts a void global/static function with a single argument and builds the function object around it.

Parameters
function: a global/static function with a single argument.

Definition at line 255 of file function_objects.hpp.

◆ ~UnaryFreeFunction()

template<typename A >
virtual ecl::UnaryFreeFunction< A, void >::~UnaryFreeFunction ( )
inlinevirtual

Definition at line 257 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename A >
void ecl::UnaryFreeFunction< A, void >::operator() ( a)
inlinevirtual

This ensures any children objects are deleted correctly.

A unary function object call.

Redirects the unary function object call to the composited void global/static function.

Returns
R : the function's return value.

Implements ecl::UnaryFunction< A, void >.

Definition at line 265 of file function_objects.hpp.

Member Data Documentation

◆ free_function

template<typename A >
void(* ecl::UnaryFreeFunction< A, void >::free_function) (A)
private

Definition at line 268 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