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

Creates a nullary function from a reference wrapper. More...

#include <function_objects.hpp>

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

Public Member Functions

 NullaryFunctionReference (const ReferenceWrapper< FunctionObject > &wrapper)
 Creates a NullaryFunction descendant from a reference wrapper. More...
 
Result operator() ()
 This ensures any children objects are deleted correctly. More...
 
virtual ~NullaryFunctionReference ()
 
- Public Member Functions inherited from ecl::NullaryFunction< void >
virtual ~NullaryFunction ()
 

Private Attributes

FunctionObject & function_object
 

Additional Inherited Members

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

Detailed Description

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

Creates a nullary function from a reference wrapper.

Takes a reference wrapper containing a nullary function (strictly by definition) object reference and creates a NullaryFunction descendant. This is useful in utilising the inheritance from NullaryFunction (needed for slots and similar classes).

Template Parameters
FunctionObject: type of the function object to be referenced.
Result: the return type of the nullary function.
See also
NullaryFunctionReference<FunctionObject,void>, FunctionObjects.

Definition at line 941 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ NullaryFunctionReference()

template<typename FunctionObject , typename Result = void>
ecl::NullaryFunctionReference< FunctionObject, Result >::NullaryFunctionReference ( const ReferenceWrapper< FunctionObject > &  wrapper)
inlineexplicit

Creates a NullaryFunction descendant from a reference wrapper.

Creates a NullaryFunction descendant by reference (not copying).

Parameters
wrapper: the reference wrapper holding the nullary function object to be referenced.

Definition at line 951 of file function_objects.hpp.

◆ ~NullaryFunctionReference()

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

Definition at line 954 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename FunctionObject , typename Result = void>
Result ecl::NullaryFunctionReference< FunctionObject, Result >::operator() ( )
inlinevirtual

This ensures any children objects are deleted correctly.

The nullary function object call.

Redirects the call to the referenced nullary function object call.

Returns
R : the function's return value.

Implements ecl::NullaryFunction< void >.

Definition at line 963 of file function_objects.hpp.

Member Data Documentation

◆ function_object

template<typename FunctionObject , typename Result = void>
FunctionObject& ecl::NullaryFunctionReference< FunctionObject, Result >::function_object
private

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