RWTFunctor1<S1>

Module:  Threads   Package:  Functor

RWTFunctor1<S1>   RWHandleBase 

• Local Index
• Header File
• Description
• Example
• Public Typedefs
• Public Constructors
• Public Destructor
• Public Member Operators
• Protected Member Function
• See Also

Members

body() CallerSignature

operator()() operator=()

RWTFunctor1() S1Type

~RWTFunctor1()

#include <rw/functor/functor1.h>

RWTFunctor1<S1> represents the group of functors that are invoked with one argument, and whose invocation returns no value.

A function object, or a functor, is an object that encapsulates a call to an associated global or member function. When a functor is invoked, it calls the associated function.

Instances of class RWTFunctor1 act as handles to functor implementations or bodies. Such implementations are created by using either the rwtMakeFunctor1() global functions or macros. Each of these methods creates a new body instance, and returns the handle to that instance. See the example below.

Note that although an instance of this class is invoked with one argument, and returns no value, the encapsulated function may have more arguments and a return value.

The additional arguments that will be passed to the encapsulated function are provided to the functor at the time of creation. They are stored within the functor object, and are retrieved at the time of invocation.

Any return value that the function may have will be ignored by the functor, and hence not passed back to the user. If you are interested in the function's return value, see the RWTFunctorR2 group of classes.

#include <iostream.h>
#include <rw/functor/functor1.h>

void foo(int x){ cout << "x is " << x << endl;  }

int main () {
// Create a handle, and assign a new body to it.
   RWTFunctor1<int> functor = rwtMakeFunctor1( (void(*)(int))0,
                               foo );

// Invoke the functor with one caller argument.
   functor(42);

  return 0;
}

OUTPUT:
x is 42

typedef S1 S1Type;

The type of the caller argument.

typedef void (*CallerSignature)(S1);

The signature of the functor invocation.

RWTFunctor1();

Constructs an empty, invalid, handle instance. To create a viable handle, use the rwtMakeFunctor1() global functions or macros.

RWTFunctor1(RWStaticCtor);

Constructs a global static handle instance. Constructor will not reset any values that may have been set in invocations prior to the constructor call.

RWTFunctor1(RWTFunctor1Imp<S1>* functorInp);

Body constructor. Constructs a new RWTFunctor1 handle from an existing body.

RWTFunctor1(const RWTFunctor1<S1>& second);

Copy constructor. Binds a new handle instance to the functor body instance, if any, associated with the second handle instance.

~RWTFunctor1();

Destructor.

RWTFunctor1<S1>& 
operator=(const RWTFunctor1<S1>& second);

Assignment operator. Detaches this handle instance from any functor body instance it currently references, and binds it to the functor body instance, if any, associated with the second handle instance.

void 
operator()(S1 s1) const;

Invokes the functor, calling the encapsulated function. Throws an RWTHRInvalidPointer if the handle has no associated body.

RWTFunctor1Imp<S1>&
body() const;

Gets a reference for the body instance, if any; otherwise, throws an RWTHRInvalidPointer exception.

rwtMakeFunctor1()

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.