Public Member Functions | Private Attributes | List of all members
ecl::UnaryFunctionCopy< FunctionObject, T, Result > Class Template Reference

Create a UnaryFunction object composited from an existing function object. More...

#include <function_objects.hpp>

Inheritance diagram for ecl::UnaryFunctionCopy< FunctionObject, T, Result >:
Inheritance graph
[legend]

Public Member Functions

Result operator() (T t)
 This ensures any children objects are deleted correctly. More...
 
 UnaryFunctionCopy (const FunctionObject &f_o)
 UnaryFunction child constructor for unary function objects. More...
 
virtual ~UnaryFunctionCopy ()
 
- Public Member Functions inherited from ecl::UnaryFunction< T, void >
virtual ~UnaryFunction ()
 

Private Attributes

FunctionObject function_object
 

Additional Inherited Members

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

Detailed Description

template<typename FunctionObject, typename T, typename Result = void>
class ecl::UnaryFunctionCopy< FunctionObject, T, Result >

Create a UnaryFunction object composited from an existing function object.

Takes a unary function object (strictly by definition) and creates a UnaryFunction child object. This is useful in utilising the inheritance from UnaryFunction (needed for slots and similar classes).

Template Parameters
FunctionObject: type of the function object to be wrapped.
T: the unary data type.
R: the return type.
See also
FunctionObjects.

Definition at line 1022 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ UnaryFunctionCopy()

template<typename FunctionObject , typename T , typename Result = void>
ecl::UnaryFunctionCopy< FunctionObject, T, Result >::UnaryFunctionCopy ( const FunctionObject &  f_o)
inline

UnaryFunction child constructor for unary function objects.

Creates a child of the UnaryFunction class by copying a unary function object (one that is purely by definition).

Parameters
f_o: the function object to be assigned to the UnaryFunction child.

Definition at line 1033 of file function_objects.hpp.

◆ ~UnaryFunctionCopy()

template<typename FunctionObject , typename T , typename Result = void>
virtual ecl::UnaryFunctionCopy< FunctionObject, T, Result >::~UnaryFunctionCopy ( )
inlinevirtual

Definition at line 1036 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename FunctionObject , typename T , typename Result = void>
Result ecl::UnaryFunctionCopy< FunctionObject, T, Result >::operator() ( t)
inlinevirtual

This ensures any children objects are deleted correctly.

The unary function object call.

Redirects the call to the composited nullary function object call.

Returns
R : the function's return value.

Implements ecl::UnaryFunction< T, void >.

Definition at line 1045 of file function_objects.hpp.

Member Data Documentation

◆ function_object

template<typename FunctionObject , typename T , typename Result = void>
FunctionObject ecl::UnaryFunctionCopy< FunctionObject, T, Result >::function_object
private

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