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

Specialisation of the bound nullary member function for void functions. More...

#include <function_objects.hpp>

Inheritance diagram for ecl::BoundNullaryMemberFunction< C, void >:
Inheritance graph
[legend]

Public Member Functions

 BoundNullaryMemberFunction (void(C::*function)(), C &class_object)
 Binds a unary member function and creates a nullary function object. More...
 
void operator() ()
 This ensures any children objects are deleted correctly. More...
 
virtual ~BoundNullaryMemberFunction ()
 
- Public Member Functions inherited from ecl::NullaryFunction< void >
virtual ~NullaryFunction ()
 

Private Attributes

C & member_class
 
void(C::* member_function )()
 

Additional Inherited Members

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

Detailed Description

template<typename C>
class ecl::BoundNullaryMemberFunction< C, void >

Specialisation of the bound nullary member function for void functions.

Binds the class instance for a nullary member function and uses this to construct a nullary function object. This is the specialisation for nullary member functions with void return type.

Template Parameters
C: the member function's class type.
See also
ecl::utilities::BoundNullaryMemberFunction, generateFunctionObject, FunctionObjects.

Definition at line 634 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ BoundNullaryMemberFunction()

template<typename C >
ecl::BoundNullaryMemberFunction< C, void >::BoundNullaryMemberFunction ( void(C::*)()  function,
C &  class_object 
)
inline

Binds a unary member function and creates a nullary function object.

Accepts the function pointer and class instance, binds them and creates a nullary function object.

Parameters
function: the void member function.
class_object: the member function's class instance.

Definition at line 644 of file function_objects.hpp.

◆ ~BoundNullaryMemberFunction()

template<typename C >
virtual ecl::BoundNullaryMemberFunction< C, void >::~BoundNullaryMemberFunction ( )
inlinevirtual

Definition at line 649 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename C >
void ecl::BoundNullaryMemberFunction< C, void >::operator() ( )
inlinevirtual

This ensures any children objects are deleted correctly.

A nullary function object call.

Redirects the nullary function object call to the bound member function.

Implements ecl::NullaryFunction< void >.

Definition at line 655 of file function_objects.hpp.

Member Data Documentation

◆ member_class

template<typename C >
C& ecl::BoundNullaryMemberFunction< C, void >::member_class
private

Definition at line 658 of file function_objects.hpp.

◆ member_function

template<typename C >
void(C::* ecl::BoundNullaryMemberFunction< C, void >::member_function) ()
private

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