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

Specialisation of the binary function object for void unary member functions. More...

#include <function_objects.hpp>

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

Public Member Functions

void operator() (C &class_object, A a)
 This ensures any children objects are deleted correctly. More...
 
 UnaryMemberFunction (void(C::*function)(A))
 Binary function object constructor for unary member functions. More...
 
virtual ~UnaryMemberFunction ()
 
- Public Member Functions inherited from ecl::BinaryFunction< C &, A, void >
virtual ~BinaryFunction ()
 

Private Attributes

void(C::* member_function )(A)
 

Additional Inherited Members

- Public Types inherited from ecl::BinaryFunction< C &, A, void >
typedef C & first_argument_type
 The first argument type. More...
 
typedef void result_type
 The result type. More...
 
typedef A second_argument_type
 The second argument type. More...
 

Detailed Description

template<typename C, typename A>
class ecl::UnaryMemberFunction< C, A, void >

Specialisation of the binary function object for void unary member functions.

Specialises the binary member function object for void member functions.

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

Definition at line 533 of file function_objects.hpp.

Constructor & Destructor Documentation

◆ UnaryMemberFunction()

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

Binary function object constructor for unary member functions.

Accepts a unary member function, and builds the function object around it.

Parameters
function: a unary member function.

Definition at line 543 of file function_objects.hpp.

◆ ~UnaryMemberFunction()

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

Definition at line 544 of file function_objects.hpp.

Member Function Documentation

◆ operator()()

template<typename C , typename A >
void ecl::UnaryMemberFunction< C, A, void >::operator() ( C &  class_object,
a 
)
inlinevirtual

This ensures any children objects are deleted correctly.

A binary function object call.

Uses the specified class instance and argument to redirect the function call to the unary member function.

Parameters
class_object: the member function's class instance.
a: the member function's argument value.
Returns
R : the function's return value.

Implements ecl::BinaryFunction< C &, A, void >.

Definition at line 555 of file function_objects.hpp.

Member Data Documentation

◆ member_function

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

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