ecl::BoundUnaryMemberFunction< C, A, R > Class Template Reference

Nullary function object for bound unary member functions. More...

#include <function_objects.hpp>

Inheritance diagram for ecl::BoundUnaryMemberFunction< C, A, R >:

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

Private Attributes
A	argument
C &	member_class
void(C::*	member_function )(A)

Additional Inherited Members
Public Types inherited from ecl::NullaryFunction< R >
typedef R	result_type
	The result type. More...

Detailed Description

template<typename C, typename A, typename R = void>
class ecl::BoundUnaryMemberFunction< C, A, R >

Nullary function object for bound unary member functions.

Binds the class instance and argument for a unary member function and uses this to construct a nullary function object.

Usage:

class A {
public:
    void f(int i) { //...
    }

int main() {
    A a;
    BoundUnaryMemberFunction<A,int,void> function_object(&A::f,a,1);
    function_object();
}

See also

generateFunctionObject

Template Parameters

C	: the member function's class type.
A	: the member function's argument type.
R	: the return type.

See also

FunctionObjects.

Definition at line 744 of file function_objects.hpp.

Constructor & Destructor Documentation

BoundUnaryMemberFunction()

template<typename C, typename A, typename R = void>

ecl::BoundUnaryMemberFunction< C, A, R >::BoundUnaryMemberFunction ( R(C::*)(A)  function, C &  class_object, A  a  )

inline

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

Accepts the function, class instance and a value for its single argument, binds them and creates a nullary function object.

Parameters

function	: the unary global/static function.
class_object	: the member function's class instance.
a	: the value of the argument to bind.

Definition at line 755 of file function_objects.hpp.

~BoundUnaryMemberFunction()

template<typename C, typename A, typename R = void>

virtual ecl::BoundUnaryMemberFunction< C, A, R >::~BoundUnaryMemberFunction ( )

inlinevirtual

Definition at line 760 of file function_objects.hpp.

Member Function Documentation

operator()()

template<typename C, typename A, typename R = void>

R ecl::BoundUnaryMemberFunction< C, A, R >::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.

Returns

R : the function's return value.

Implements ecl::NullaryFunction< R >.

Definition at line 768 of file function_objects.hpp.

Member Data Documentation

argument

template<typename C, typename A, typename R = void>

A ecl::BoundUnaryMemberFunction< C, A, R >::argument

private

Definition at line 774 of file function_objects.hpp.

member_class

template<typename C, typename A, typename R = void>

C& ecl::BoundUnaryMemberFunction< C, A, R >::member_class

private

Definition at line 772 of file function_objects.hpp.

member_function

template<typename C, typename A, typename R = void>

void(C::* ecl::BoundUnaryMemberFunction< C, A, R >::member_function) (A)

private

Definition at line 773 of file function_objects.hpp.

---

The documentation for this class was generated from the following file:

• function_objects.hpp