blob: c61085e693a198dc0a74ce32a1cdef1c51d275a6 (
plain)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>automotive-message-broker: Libamb</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">automotive-message-broker
 <span id="projectnumber">0.14.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#files">Files</a> |
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Libamb</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:debugout_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="debugout_8h.html">debugout.h</a></td></tr>
<tr class="memdesc:debugout_8h"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classDebugOut.html">DebugOut</a> class represents a class used for outputing debug information The specified debug level will only be outputed if the debug level is => the debug threshhold Here's a simple example: <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPlugin.html">AmbPlugin< T ></a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html">AmbPluginImpl</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classAmbPlugin.html">AmbPlugin</a> private class implementation - base class for all plugin implementations. <a href="classAmbPluginImpl.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugOut.html">DebugOut</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaeba07a0735880a7a49644f7413a03db5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gaeba07a0735880a7a49644f7413a03db5">AmbPlugin< T >::AmbPlugin</a> (<a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> *re, const std::map< std::string, std::string > &config)</td></tr>
<tr class="separator:gaeba07a0735880a7a49644f7413a03db5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d965dd88d158b4af1f609317b674098"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga6d965dd88d158b4af1f609317b674098">AmbPlugin< T >::getPropertyAsync</a> (<a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> *reply)</td></tr>
<tr class="memdesc:ga6d965dd88d158b4af1f609317b674098"><td class="mdescLeft"> </td><td class="mdescRight">getPropertyAsync is called when a sink requests the value for given property. This is only called if the source supports the Get operation. <a href="#ga6d965dd88d158b4af1f609317b674098">More...</a><br /></td></tr>
<tr class="separator:ga6d965dd88d158b4af1f609317b674098"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab052ed4dea097b25aa9aec76f151175f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gab052ed4dea097b25aa9aec76f151175f">AmbPlugin< T >::getRangePropertyAsync</a> (<a class="el" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> *reply)</td></tr>
<tr class="memdesc:gab052ed4dea097b25aa9aec76f151175f"><td class="mdescLeft"> </td><td class="mdescRight">getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation. <a href="#gab052ed4dea097b25aa9aec76f151175f">More...</a><br /></td></tr>
<tr class="separator:gab052ed4dea097b25aa9aec76f151175f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9348b743e7f678c4b98b9681199844ad"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga9348b743e7f678c4b98b9681199844ad">AmbPlugin< T >::setProperty</a> (<a class="el" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> request)</td></tr>
<tr class="memdesc:ga9348b743e7f678c4b98b9681199844ad"><td class="mdescLeft"> </td><td class="mdescRight">setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation. <a href="#ga9348b743e7f678c4b98b9681199844ad">More...</a><br /></td></tr>
<tr class="separator:ga9348b743e7f678c4b98b9681199844ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab98182f95801527bec4d972f37d3c92b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gab98182f95801527bec4d972f37d3c92b">AmbPlugin< T >::subscribeToPropertyChanges</a> (VehicleProperty::Property property)</td></tr>
<tr class="memdesc:gab98182f95801527bec4d972f37d3c92b"><td class="mdescLeft"> </td><td class="mdescRight">subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions. <a href="#gab98182f95801527bec4d972f37d3c92b">More...</a><br /></td></tr>
<tr class="separator:gab98182f95801527bec4d972f37d3c92b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ebede30c34aa80c3833db9d744474d0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga1ebede30c34aa80c3833db9d744474d0">AmbPlugin< T >::unsubscribeToPropertyChanges</a> (VehicleProperty::Property property)</td></tr>
<tr class="memdesc:ga1ebede30c34aa80c3833db9d744474d0"><td class="mdescLeft"> </td><td class="mdescRight">unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. <a href="#ga1ebede30c34aa80c3833db9d744474d0">More...</a><br /></td></tr>
<tr class="separator:ga1ebede30c34aa80c3833db9d744474d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga877185aeb55596f1d4407e9d7add3d06"><td class="memItemLeft" align="right" valign="top">virtual PropertyList </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga877185aeb55596f1d4407e9d7add3d06">AmbPlugin< T >::supported</a> ()</td></tr>
<tr class="memdesc:ga877185aeb55596f1d4407e9d7add3d06"><td class="mdescLeft"> </td><td class="mdescRight">supported is called by the routingEngine to understand what properties this source supports <a href="#ga877185aeb55596f1d4407e9d7add3d06">More...</a><br /></td></tr>
<tr class="separator:ga877185aeb55596f1d4407e9d7add3d06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac06aaf56b38fc404f766b3ff78eafb0e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gac06aaf56b38fc404f766b3ff78eafb0e">AmbPlugin< T >::supportedOperations</a> ()</td></tr>
<tr class="memdesc:gac06aaf56b38fc404f766b3ff78eafb0e"><td class="mdescLeft"> </td><td class="mdescRight">supportedOperations <a href="#gac06aaf56b38fc404f766b3ff78eafb0e">More...</a><br /></td></tr>
<tr class="separator:gac06aaf56b38fc404f766b3ff78eafb0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga717b0cdbad39119d5f8ef55750eb280e"><td class="memItemLeft" align="right" valign="top">virtual PropertyInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga717b0cdbad39119d5f8ef55750eb280e">AmbPlugin< T >::getPropertyInfo</a> (const VehicleProperty::Property &property)</td></tr>
<tr class="memdesc:ga717b0cdbad39119d5f8ef55750eb280e"><td class="mdescLeft"> </td><td class="mdescRight">getPropertyInfo used to return specific information about a property. The source should override this otherwise a PropertyInfo::invalid() will be returned for the property. <a href="#ga717b0cdbad39119d5f8ef55750eb280e">More...</a><br /></td></tr>
<tr class="separator:ga717b0cdbad39119d5f8ef55750eb280e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga84ad326ad2f861a8b028c0b99940d470"><td class="memItemLeft" align="right" valign="top">virtual const string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga84ad326ad2f861a8b028c0b99940d470">AmbPlugin< T >::uuid</a> ()</td></tr>
<tr class="separator:ga84ad326ad2f861a8b028c0b99940d470"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf58a77165e10549dc0e30f2d1b0d7b2f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gaf58a77165e10549dc0e30f2d1b0d7b2f">AmbPlugin< T >::propertyChanged</a> (<a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> *value)</td></tr>
<tr class="separator:gaf58a77165e10549dc0e30f2d1b0d7b2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a1098c5ae43cd731c7910efd36f6f7e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#ga6a1098c5ae43cd731c7910efd36f6f7e">AmbPlugin< T >::supportedChanged</a> (const PropertyList &supportedProperties)</td></tr>
<tr class="separator:ga6a1098c5ae43cd731c7910efd36f6f7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab75521774823cbff2db31a4a624e6256"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libamb.html#gab75521774823cbff2db31a4a624e6256">AmbPlugin< T >::init</a> ()</td></tr>
<tr class="separator:gab75521774823cbff2db31a4a624e6256"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaeba07a0735880a7a49644f7413a03db5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::<a class="el" href="classAmbPlugin.html">AmbPlugin</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> * </td>
<td class="paramname"><em>re</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::map< std::string, std::string > & </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile time check</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">re</td><td><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> </td></tr>
<tr><td class="paramname">config</td><td>Map of the configuration string values loaded on startup from AMB configuration file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6d965dd88d158b4af1f609317b674098"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::getPropertyAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * </td>
<td class="paramname"><em>reply</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>getPropertyAsync is called when a sink requests the value for given property. This is only called if the source supports the Get operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reply</td><td>the reply variable. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAsyncPropertyReply.html" title="The AsyncPropertyReply class is used by sources to reply to Get and Set operations. The source should set success to true if the call is successful or 'false' if the request was not successful and set 'error' to the appropriate error. ">AsyncPropertyReply</a> </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#a05589e699ea16a14675db226d51bdf9f">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="ga717b0cdbad39119d5f8ef55750eb280e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PropertyInfo <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::getPropertyInfo </td>
<td>(</td>
<td class="paramtype">const VehicleProperty::Property & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>getPropertyInfo used to return specific information about a property. The source should override this otherwise a PropertyInfo::invalid() will be returned for the property. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>the property to get info for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a PropertyInfo object. </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#a4e15ea9df2144be322968003621580c4">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="gab052ed4dea097b25aa9aec76f151175f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::getRangePropertyAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> * </td>
<td class="paramname"><em>reply</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reply</td><td>is the reply variable. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAsyncRangePropertyReply.html" title="The AsyncRangePropertyReply class is used by a source to reply to an AsyncRangePropertyRequest. The source should set success to 'true' and populate the 'values' member if the request was successful. If the request is not successful, 'success' should be set to 'false' and the 'error' member should be set. ">AsyncRangePropertyReply</a> </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#a3b30f939d68889b2540f6035fa5be7c7">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="gab75521774823cbff2db31a4a624e6256"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Second phase of the plugin initialization. </p>
</div>
</div>
<a class="anchor" id="gaf58a77165e10549dc0e30f2d1b0d7b2f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::propertyChanged </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>propertyChanged is called when a subscribed to property changes. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>value of the property that changed. this is a temporary pointer that will be destroyed. Do not destroy it. If you need to store the value use value.anyValue(), value.value<T>() or value->copy() to copy. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classAbstractSink.html#afeb683c566a5a71303d05d2e12da2b28">AbstractSink</a>.</p>
</div>
</div>
<a class="anchor" id="ga9348b743e7f678c4b98b9681199844ad"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::setProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>the requested property to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns a pointer to the new value for the property. </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#a684b58112b5572dfe8cb94380bf7d74a">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="gab98182f95801527bec4d972f37d3c92b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::subscribeToPropertyChanges </td>
<td>(</td>
<td class="paramtype">VehicleProperty::Property </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>the property that is being subscribed. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classAbstractSource.html#ae9c042e159f080c298b2ae37c47618e9">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="ga877185aeb55596f1d4407e9d7add3d06"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PropertyList <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::supported </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>supported is called by the routingEngine to understand what properties this source supports </p>
<dl class="section return"><dt>Returns</dt><dd>returns a list of supported properties. If the the supported properties changed, the source should call AbstractRoutingEngine::setSupported. </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#ad8330cbbac84dc24851eb50ff7243460">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="ga6a1098c5ae43cd731c7910efd36f6f7e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::supportedChanged </td>
<td>(</td>
<td class="paramtype">const PropertyList & </td>
<td class="paramname"><em>supportedProperties</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group__libamb.html#ga6a1098c5ae43cd731c7910efd36f6f7e">supportedChanged()</a> is called when the supported properties changes </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">supportedProperties</td><td>the new list of supported properties. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classAbstractSink.html#aa9538a89536e8b6495551283116a588b">AbstractSink</a>.</p>
</div>
</div>
<a class="anchor" id="gac06aaf56b38fc404f766b3ff78eafb0e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::supportedOperations </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>supportedOperations </p>
<dl class="section return"><dt>Returns</dt><dd>returns the supported operations. </dd></dl>
<p>Implements <a class="el" href="classAbstractSource.html#a317861675652372a72fc01c075036b51">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="ga1ebede30c34aa80c3833db9d744474d0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::unsubscribeToPropertyChanges </td>
<td>(</td>
<td class="paramtype">VehicleProperty::Property </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>the property to unsubscribe to </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classAbstractSource.html#a584372310f191b1b9067a634b7366023">AbstractSource</a>.</p>
</div>
</div>
<a class="anchor" id="ga84ad326ad2f861a8b028c0b99940d470"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const string <a class="el" href="classAmbPlugin.html">AmbPlugin</a>< T >::uuid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group__libamb.html#ga84ad326ad2f861a8b028c0b99940d470">uuid()</a> is a unique identifier </p><dl class="section return"><dt>Returns</dt><dd>A guid-style unique identifier </dd></dl>
<p>Implements <a class="el" href="classAbstractSink.html#a965ae1d5218713c7823fbd95fa51b053">AbstractSink</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|
