1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
Adept MobileRobots Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007, 2008, 2009, 2010 MobileRobots Inc.
Copyright (C) 2011, 2012, 2013 Adept Technology
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
If you wish to redistribute ARIA under different terms, contact
Adept MobileRobots for information about a commercial version of ARIA at
robots@mobilerobots.com or
Adept MobileRobots, 10 Columbia Drive, Amherst, NH 03031; +1-603-881-7960
*/
#include <string>
#include "Aria.h"
/** @example functorExample.cpp Illustrates the use of functors
*
* @sa @ref functors in the ARIA overview
*/
/*
This is a class that has some callback methods. Functors which refer to these
callbacks will be passed to the DriverClass.
*/
class CallbackContainer
{
public:
void callback1();
void callback2(int i);
bool callback3(const char *str);
};
void CallbackContainer::callback1()
{
printf("CallbackContainer::callback1 called.\n");
}
void CallbackContainer::callback2(int i)
{
printf("CallbackContainer::callback2 called with argument of '%d'\n", i);
}
bool CallbackContainer::callback3(const char *str)
{
printf("CallbackContainer::callback3 called with argument of '%s'.\n", str);
return(true);
}
/*
* Functors can also invoke global functions.
*/
void globalCallback()
{
printf("globalCallback() called.\n");
}
/*
This is a "driver" class. It takes three functors of different types and
will invoke the three functors. This is a typical use of
functors: to pass information or event notifications between loosely
coupled objects.
*/
class DriverClass
{
public:
void invokeFunctors();
void setCallback1(ArFunctor *func) {myFunc1=func;}
void setCallback2(ArFunctor1<int> *func) {myFunc2=func;}
void setCallback3(ArRetFunctor1<bool, const char *> *func) {myFunc3=func;}
protected:
ArFunctor *myFunc1;
ArFunctor1<int> *myFunc2;
ArRetFunctor1<bool, const char *> *myFunc3;
};
void DriverClass::invokeFunctors()
{
bool ret;
printf("Invoking functor1... ");
myFunc1->invoke();
printf("Invoking functor2... ");
myFunc2->invoke(23);
/*
For functors with return values, use invorkeR() instead of invoke()
to get the return value. The invoke() function can also be used to invoke
the functor, but the return value is lost. (And is a possible source
of memory leaks if you were supposed to free a pointer returned.)
*/
printf("Invoking functor3... ");
ret=myFunc3->invokeR("This is a string argument");
if (ret)
printf("\t-> functor3 returned 'true'\n");
else
printf("\t-> functor3 returned 'false'\n");
}
int main()
{
CallbackContainer cb;
DriverClass driver;
ArFunctorC<CallbackContainer> functor1(cb, &CallbackContainer::callback1);
ArFunctor1C<CallbackContainer, int> functor2(cb, &CallbackContainer::callback2);
ArRetFunctor1C<bool, CallbackContainer, const char *>
functor3(cb, &CallbackContainer::callback3);
driver.setCallback1(&functor1);
driver.setCallback2(&functor2);
driver.setCallback3(&functor3);
driver.invokeFunctors();
/* You can make functors that target global functions too. */
ArGlobalFunctor globalFunctor(&globalCallback);
printf("Invoking globalFunctor... ");
globalFunctor.invoke();
/* You can also include the values of arguments in an ArFunctor object, if you
* want to use the same value in every invocation of the functor.
*/
ArFunctor1C<CallbackContainer, int> functor4(cb, &CallbackContainer::callback2, 42);
printf("Invoking functor with constant argument... ");
functor4.invoke();
/* Functors can be downcast to parent interface classes, as long as their invocation
* does not require arguments.
*/
ArFunctor* baseFunctor = &functor4;
printf("Invoking downcast functor... ");
baseFunctor->invoke();
return(0);
}
|
