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

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

#include <function_objects.hpp>

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

Public Member Functions

 NullaryFunctionReference (const ReferenceWrapper< FunctionObject > &wrapper)
 Creates a NullaryFunction descendant from a reference wrapper. More...
 
void 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>
class ecl::NullaryFunctionReference< FunctionObject, void >

Creates a void 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 a specialisation which caters to nullary function objects with void return type.

Template Parameters
FunctionObject: type of the function object to be referenced.
See also
NullaryFunctionReference, FunctionObjects.

Definition at line 981 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ NullaryFunctionReference()

template<typename FunctionObject >
ecl::NullaryFunctionReference< FunctionObject, void >::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 991 of file function_objects.hpp.

◆ ~NullaryFunctionReference()

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

Definition at line 994 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename FunctionObject >
void ecl::NullaryFunctionReference< FunctionObject, void >::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.

Implements ecl::NullaryFunction< void >.

Definition at line 1001 of file function_objects.hpp.

Member Data Documentation

◆ function_object

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

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