-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathclass_r_t_actor.html
More file actions
1212 lines (1111 loc) · 76.1 KB
/
class_r_t_actor.html
File metadata and controls
1212 lines (1111 loc) · 76.1 KB
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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>C++ TargetRTS: RTActor Class Reference</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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">C++ TargetRTS
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="class_r_t_actor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTActor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>An instance of this class represents a capsule instance.
<a href="class_r_t_actor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_r_t_actor_8h_source.html">RTActor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for RTActor:</div>
<div class="dyncontent">
<div class="center">
<img src="class_r_t_actor.png" usemap="#RTActor_map" alt=""/>
<map id="RTActor_map" name="RTActor_map">
<area href="class_r_t_connector___actor.html" alt="RTConnector_Actor" shape="rect" coords="0,56,124,80"/>
<area href="class_r_t_super_actor.html" alt="RTSuperActor" shape="rect" coords="134,56,258,80"/>
<area href="class_r_t_timer_actor.html" alt="RTTimerActor" shape="rect" coords="268,56,392,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9eb1ab141a21096ca16c4e1596fe0854"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a9eb1ab141a21096ca16c4e1596fe0854">RTActor</a> (<a class="el" href="class_r_t_controller.html">RTController</a> *, <a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *)</td></tr>
<tr class="memdesc:a9eb1ab141a21096ca16c4e1596fe0854"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a9eb1ab141a21096ca16c4e1596fe0854"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a940c3401d6050526c0f43bce28c22b95"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a940c3401d6050526c0f43bce28c22b95">getIndex</a> (void) const</td></tr>
<tr class="memdesc:a940c3401d6050526c0f43bce28c22b95"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated). <br /></td></tr>
<tr class="separator:a940c3401d6050526c0f43bce28c22b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa654235fd395c0c56f1f706b99a33cfe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#aa654235fd395c0c56f1f706b99a33cfe">index</a> (void) const</td></tr>
<tr class="memdesc:aa654235fd395c0c56f1f706b99a33cfe"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated). <br /></td></tr>
<tr class="separator:aa654235fd395c0c56f1f706b99a33cfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afda516f64e3f5af79d7514a70c73ae12"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#afda516f64e3f5af79d7514a70c73ae12">getId</a> (void) const</td></tr>
<tr class="memdesc:afda516f64e3f5af79d7514a70c73ae12"><td class="mdescLeft"> </td><td class="mdescRight">Get the numeric id for the capsule part that contains this capsule instance. <br /></td></tr>
<tr class="separator:afda516f64e3f5af79d7514a70c73ae12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bb3738e9b1c8d810e6cbab96305e73e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a7bb3738e9b1c8d810e6cbab96305e73e">getName</a> (void) const</td></tr>
<tr class="memdesc:a7bb3738e9b1c8d810e6cbab96305e73e"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the capsule part that contains this capsule instance. <br /></td></tr>
<tr class="separator:a7bb3738e9b1c8d810e6cbab96305e73e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac53c20a187b69a8cbfcd32784dfee8a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ac53c20a187b69a8cbfcd32784dfee8a0">getReference</a> (void) const</td></tr>
<tr class="memdesc:ac53c20a187b69a8cbfcd32784dfee8a0"><td class="mdescLeft"> </td><td class="mdescRight">Get the capsule part that contains this capsule instance (the capsule part where it was incarnated). <br /></td></tr>
<tr class="separator:ac53c20a187b69a8cbfcd32784dfee8a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e7fcb9e60ed9f8e9aa3acc4fde319e8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_r_t_message.html">RTMessage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a8e7fcb9e60ed9f8e9aa3acc4fde319e8">getMsg</a> (void)</td></tr>
<tr class="memdesc:a8e7fcb9e60ed9f8e9aa3acc4fde319e8"><td class="mdescLeft"> </td><td class="mdescRight">Get the message which is currently being processed by the capsule instance. <br /></td></tr>
<tr class="separator:a8e7fcb9e60ed9f8e9aa3acc4fde319e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5e7bdb38e769bab6d4b82f940a07786"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ae5e7bdb38e769bab6d4b82f940a07786">sendCopyToMe</a> (const <a class="el" href="class_r_t_message.html">RTMessage</a> *<a class="el" href="class_r_t_actor.html#a86e67b3cf069baa9fd58fad4abf3bc58">msg</a>)</td></tr>
<tr class="memdesc:ae5e7bdb38e769bab6d4b82f940a07786"><td class="mdescLeft"> </td><td class="mdescRight">Make a copy of a message and send it to this capsule instance. <br /></td></tr>
<tr class="separator:ae5e7bdb38e769bab6d4b82f940a07786"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab318ad0d3a0510da89da3d7858cdaa74"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ab318ad0d3a0510da89da3d7858cdaa74">rtsBehavior</a> (int signal, int port)=0</td></tr>
<tr class="memdesc:ab318ad0d3a0510da89da3d7858cdaa74"><td class="mdescLeft"> </td><td class="mdescRight">Defines the state machine behavior for this capsule instance. <br /></td></tr>
<tr class="separator:ab318ad0d3a0510da89da3d7858cdaa74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67fc8760790c667bdbae0d2005738f4e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a67fc8760790c667bdbae0d2005738f4e">logMsg</a> (void)</td></tr>
<tr class="memdesc:a67fc8760790c667bdbae0d2005738f4e"><td class="mdescLeft"> </td><td class="mdescRight">This function is called just before a received message is processed by the capsule instance. <br /></td></tr>
<tr class="separator:a67fc8760790c667bdbae0d2005738f4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed6931db977ea5d6cf6002d7b094f9e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_r_t_controller.html">RTController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#aed6931db977ea5d6cf6002d7b094f9e2">context</a> (void) const</td></tr>
<tr class="memdesc:aed6931db977ea5d6cf6002d7b094f9e2"><td class="mdescLeft"> </td><td class="mdescRight">Get the controller which runs this capsule instance. <br /></td></tr>
<tr class="separator:aed6931db977ea5d6cf6002d7b094f9e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a633724e6bb61aef8f59ea07fe21a11d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a633724e6bb61aef8f59ea07fe21a11d8">isActive</a> (void) const</td></tr>
<tr class="memdesc:a633724e6bb61aef8f59ea07fe21a11d8"><td class="mdescLeft"> </td><td class="mdescRight">Determines if this capsule instance is currently active, i.e. <br /></td></tr>
<tr class="separator:a633724e6bb61aef8f59ea07fe21a11d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98a5ef32124b580417cd11bea159677c"><td class="memItemLeft" align="right" valign="top"><a id="a98a5ef32124b580417cd11bea159677c" name="a98a5ef32124b580417cd11bea159677c"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>designLevel</b> (void) const</td></tr>
<tr class="separator:a98a5ef32124b580417cd11bea159677c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01c745d5874c0345a910ae7c389746be"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a01c745d5874c0345a910ae7c389746be">getTypeName</a> (void) const</td></tr>
<tr class="memdesc:a01c745d5874c0345a910ae7c389746be"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the capsule. <br /></td></tr>
<tr class="separator:a01c745d5874c0345a910ae7c389746be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e3a0a9a0706b5631b2d7b548d6630fb"><td class="memItemLeft" align="right" valign="top"><a id="a4e3a0a9a0706b5631b2d7b548d6630fb" name="a4e3a0a9a0706b5631b2d7b548d6630fb"></a>
RTVersionId </td><td class="memItemRight" valign="bottom"><b>getVersion</b> (void) const</td></tr>
<tr class="separator:a4e3a0a9a0706b5631b2d7b548d6630fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4d48aa9ccc5919d8804740b785e93bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ae4d48aa9ccc5919d8804740b785e93bc">isSameType</a> (const <a class="el" href="struct_r_t_actor_class.html">RTActorClass</a> *cap) const</td></tr>
<tr class="memdesc:ae4d48aa9ccc5919d8804740b785e93bc"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the type of this capsule instance is a particular capsule type. <br /></td></tr>
<tr class="separator:ae4d48aa9ccc5919d8804740b785e93bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4290a978236d714a248ba073a1fe72f7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a4290a978236d714a248ba073a1fe72f7">isType</a> (const char *str) const</td></tr>
<tr class="memdesc:a4290a978236d714a248ba073a1fe72f7"><td class="mdescLeft"> </td><td class="mdescRight">Performs a lexical comparison between the name of the capsule with a specified string. <br /></td></tr>
<tr class="separator:a4290a978236d714a248ba073a1fe72f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9970639cb3dbc0d7a77c57f60fcae59b"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="struct_r_t_actor__class.html">RTActor_class</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a9970639cb3dbc0d7a77c57f60fcae59b">getActorData</a> (void) const =0</td></tr>
<tr class="memdesc:a9970639cb3dbc0d7a77c57f60fcae59b"><td class="mdescLeft"> </td><td class="mdescRight">Get information (meta data) about the capsule, such as its name, ports, states etc. <br /></td></tr>
<tr class="separator:a9970639cb3dbc0d7a77c57f60fcae59b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fbb7d06ff8917ebf2fe9aa5506a4dd1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a2fbb7d06ff8917ebf2fe9aa5506a4dd1">getNumStates</a> (void) const</td></tr>
<tr class="memdesc:a2fbb7d06ff8917ebf2fe9aa5506a4dd1"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of states in the capsule state machine. <br /></td></tr>
<tr class="separator:a2fbb7d06ff8917ebf2fe9aa5506a4dd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35e84411e86127d6d3a12d8bc3cd0087"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a35e84411e86127d6d3a12d8bc3cd0087">getStateString</a> (int s) const</td></tr>
<tr class="memdesc:a35e84411e86127d6d3a12d8bc3cd0087"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of one of the states in the capsule state machine. <br /></td></tr>
<tr class="separator:a35e84411e86127d6d3a12d8bc3cd0087"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad639bcde16f0d542877bf0aaf6688769"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ad639bcde16f0d542877bf0aaf6688769">getCurrentStateString</a> (void) const</td></tr>
<tr class="memdesc:ad639bcde16f0d542877bf0aaf6688769"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the currently active state in the capsule state machine. <br /></td></tr>
<tr class="separator:ad639bcde16f0d542877bf0aaf6688769"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a643273b1669ca63ca8c1c1026a1da77f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a643273b1669ca63ca8c1c1026a1da77f">getCurrentState</a> (void) const</td></tr>
<tr class="memdesc:a643273b1669ca63ca8c1c1026a1da77f"><td class="mdescLeft"> </td><td class="mdescRight">Get the numeric id of the currently active state in the capsule state machine. <br /></td></tr>
<tr class="separator:a643273b1669ca63ca8c1c1026a1da77f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad302b969014411874fb126de958c11fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ad302b969014411874fb126de958c11fd">getHistory</a> (int) const</td></tr>
<tr class="memdesc:ad302b969014411874fb126de958c11fd"><td class="mdescLeft"> </td><td class="mdescRight">Get the numeric id of the previously active state in the capsule state machine. <br /></td></tr>
<tr class="separator:ad302b969014411874fb126de958c11fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bb1ad62f71321340fdbe7c859d944d1"><td class="memItemLeft" align="right" valign="top"><a id="a4bb1ad62f71321340fdbe7c859d944d1" name="a4bb1ad62f71321340fdbe7c859d944d1"></a>
int </td><td class="memItemRight" valign="bottom"><b>_numComponents</b> (void) const</td></tr>
<tr class="separator:a4bb1ad62f71321340fdbe7c859d944d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96e62ce1328e9e2f17667170f986e859"><td class="memItemLeft" align="right" valign="top"><a id="a96e62ce1328e9e2f17667170f986e859" name="a96e62ce1328e9e2f17667170f986e859"></a>
<a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> * </td><td class="memItemRight" valign="bottom"><b>_component</b> (int compId)</td></tr>
<tr class="separator:a96e62ce1328e9e2f17667170f986e859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab211fe5ea24160788da3cd5eb0794e4f"><td class="memItemLeft" align="right" valign="top"><a id="ab211fe5ea24160788da3cd5eb0794e4f" name="ab211fe5ea24160788da3cd5eb0794e4f"></a>
void </td><td class="memItemRight" valign="bottom"><b>_preinitialize</b> (int _homeIndex, const <a class="el" href="struct_r_t_component_descriptor.html">RTComponentDescriptor</a> *)</td></tr>
<tr class="separator:ab211fe5ea24160788da3cd5eb0794e4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf79df29104e6fd2d10fb08ffd8a8060"><td class="memItemLeft" align="right" valign="top"><a id="abf79df29104e6fd2d10fb08ffd8a8060" name="abf79df29104e6fd2d10fb08ffd8a8060"></a>
int </td><td class="memItemRight" valign="bottom"><b>initMe</b> (const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, <a class="el" href="class_r_t_controller.html">RTController</a> *sender)</td></tr>
<tr class="separator:abf79df29104e6fd2d10fb08ffd8a8060"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc04fd06af2245bd9218a09921213f8c"><td class="memItemLeft" align="right" valign="top"><a id="afc04fd06af2245bd9218a09921213f8c" name="afc04fd06af2245bd9218a09921213f8c"></a>
int </td><td class="memItemRight" valign="bottom"><b>isReferencedBy</b> (const <a class="el" href="class_r_t_actor.html">RTActor</a> *) const</td></tr>
<tr class="separator:afc04fd06af2245bd9218a09921213f8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a195ae09e6f66d9a4f307d838f4bc633b"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="struct_r_t_actor_class.html">RTActorClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a195ae09e6f66d9a4f307d838f4bc633b">defaultClass</a> (<a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> &component, int repIndex)</td></tr>
<tr class="memdesc:a195ae09e6f66d9a4f307d838f4bc633b"><td class="mdescLeft"> </td><td class="mdescRight">Get the default capsule class for a capsule part contained in the capsule instance. <br /></td></tr>
<tr class="separator:a195ae09e6f66d9a4f307d838f4bc633b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacd08da765f7c39f775971057bc5a39a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_r_t_controller.html">RTController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#aacd08da765f7c39f775971057bc5a39a">defaultController</a> (<a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> &component, int repIndex)</td></tr>
<tr class="memdesc:aacd08da765f7c39f775971057bc5a39a"><td class="mdescLeft"> </td><td class="mdescRight">Get the default controller for a capsule part contained in the capsule instance. <br /></td></tr>
<tr class="separator:aacd08da765f7c39f775971057bc5a39a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad14bd0736aa85ee0bdd6776c7a7064a3"><td class="memItemLeft" align="right" valign="top"><a id="ad14bd0736aa85ee0bdd6776c7a7064a3" name="ad14bd0736aa85ee0bdd6776c7a7064a3"></a>
void </td><td class="memItemRight" valign="bottom"><b>_incarnateAllFixed</b> (void)</td></tr>
<tr class="separator:ad14bd0736aa85ee0bdd6776c7a7064a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6e10029cbee601ec3ecd30cbbc81e05"><td class="memItemLeft" align="right" valign="top"><a id="af6e10029cbee601ec3ecd30cbbc81e05" name="af6e10029cbee601ec3ecd30cbbc81e05"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>_followOutV</b> (<a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &end, int compId, int portId, int portIndex)</td></tr>
<tr class="separator:af6e10029cbee601ec3ecd30cbbc81e05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a519632bf1a160de77b928dcf3e91b896"><td class="memItemLeft" align="right" valign="top"><a id="a519632bf1a160de77b928dcf3e91b896" name="a519632bf1a160de77b928dcf3e91b896"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>_followInV</b> (<a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &end, int portId, int repIndex)</td></tr>
<tr class="separator:a519632bf1a160de77b928dcf3e91b896"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a86e67b3cf069baa9fd58fad4abf3bc58"><td class="memItemLeft" align="right" valign="top"><a id="a86e67b3cf069baa9fd58fad4abf3bc58" name="a86e67b3cf069baa9fd58fad4abf3bc58"></a>
const <a class="el" href="class_r_t_message.html">RTMessage</a> * </td><td class="memItemRight" valign="bottom"><b>msg</b></td></tr>
<tr class="memdesc:a86e67b3cf069baa9fd58fad4abf3bc58"><td class="mdescLeft"> </td><td class="mdescRight">The message which is currently being processed by the capsule instance. <br /></td></tr>
<tr class="separator:a86e67b3cf069baa9fd58fad4abf3bc58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8245471f1d4c871d4d02e41dd02d86a4"><td class="memItemLeft" align="right" valign="top"><a id="a8245471f1d4c871d4d02e41dd02d86a4" name="a8245471f1d4c871d4d02e41dd02d86a4"></a>
<a class="el" href="class_r_t_actor_probe.html">RTActorProbe</a> * </td><td class="memItemRight" valign="bottom"><b>probe</b></td></tr>
<tr class="memdesc:a8245471f1d4c871d4d02e41dd02d86a4"><td class="mdescLeft"> </td><td class="mdescRight">A probe attached to the capsule instance for monitoring it. <br /></td></tr>
<tr class="separator:a8245471f1d4c871d4d02e41dd02d86a4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9bda96aa79663eae7f36f498a10835f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a9bda96aa79663eae7f36f498a10835f3">saveHistory</a> (void)</td></tr>
<tr class="separator:a9bda96aa79663eae7f36f498a10835f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3532176e1f60deabb83fec7ce76bcefd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a3532176e1f60deabb83fec7ce76bcefd">setCurrentState</a> (int s)</td></tr>
<tr class="memdesc:a3532176e1f60deabb83fec7ce76bcefd"><td class="mdescLeft"> </td><td class="mdescRight">Force the state machine of the capsule instance into a particular state. <br /></td></tr>
<tr class="separator:a3532176e1f60deabb83fec7ce76bcefd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70e399ee02f601300ba838099c781608"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a70e399ee02f601300ba838099c781608">unhandledMessage</a> (void)</td></tr>
<tr class="memdesc:a70e399ee02f601300ba838099c781608"><td class="mdescLeft"> </td><td class="mdescRight">This function is called when a message is dispatched to a capsule instance, but it isn't handled by its state machine. <br /></td></tr>
<tr class="separator:a70e399ee02f601300ba838099c781608"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae43a356192a2f2dbb920d9252f5f872d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#ae43a356192a2f2dbb920d9252f5f872d">unexpectedMessage</a> (void)</td></tr>
<tr class="memdesc:ae43a356192a2f2dbb920d9252f5f872d"><td class="mdescLeft"> </td><td class="mdescRight">This function is called when a message is dispatched to the capsule instance, and when there is no enabled transition in the current state that can be triggered to handle the received message. <br /></td></tr>
<tr class="separator:ae43a356192a2f2dbb920d9252f5f872d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2e612ad1f62469bf5564641813c4e71"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#aa2e612ad1f62469bf5564641813c4e71">messageReceivedBeforeInitialized</a> (void)</td></tr>
<tr class="memdesc:aa2e612ad1f62469bf5564641813c4e71"><td class="mdescLeft"> </td><td class="mdescRight">This function is called if a message is dispatched to the capsule instance, before its initial transition has executed. <br /></td></tr>
<tr class="separator:aa2e612ad1f62469bf5564641813c4e71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ff70c41166a0ab5738eefa38541917f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a4ff70c41166a0ab5738eefa38541917f">unexpectedState</a> (void)</td></tr>
<tr class="memdesc:a4ff70c41166a0ab5738eefa38541917f"><td class="mdescLeft"> </td><td class="mdescRight">This function is called if the TargetRTS detects that the state machine of the capsule instance in in an invalid state (i.e. <br /></td></tr>
<tr class="separator:a4ff70c41166a0ab5738eefa38541917f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83ae2b2d3cf3fceee994496bbb7a147d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a83ae2b2d3cf3fceee994496bbb7a147d">rtgChainBegin</a> (int origin, const char *trans)</td></tr>
<tr class="memdesc:a83ae2b2d3cf3fceee994496bbb7a147d"><td class="mdescLeft"> </td><td class="mdescRight">This function is called at the beginning of every generated chain function that corresponds to a transition in the state machine. <br /></td></tr>
<tr class="separator:a83ae2b2d3cf3fceee994496bbb7a147d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45a0b60ee459dd55c8a4aa86d2a15620"><td class="memItemLeft" align="right" valign="top"><a id="a45a0b60ee459dd55c8a4aa86d2a15620" name="a45a0b60ee459dd55c8a4aa86d2a15620"></a>
void </td><td class="memItemRight" valign="bottom"><b>rtgTransitionBegin</b> (void)</td></tr>
<tr class="memdesc:a45a0b60ee459dd55c8a4aa86d2a15620"><td class="mdescLeft"> </td><td class="mdescRight">This function is called just before a user-defined transition effect executes. <br /></td></tr>
<tr class="separator:a45a0b60ee459dd55c8a4aa86d2a15620"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2726152217119a3709b66d25ab7795c9"><td class="memItemLeft" align="right" valign="top"><a id="a2726152217119a3709b66d25ab7795c9" name="a2726152217119a3709b66d25ab7795c9"></a>
void </td><td class="memItemRight" valign="bottom"><b>rtgTransitionEnd</b> (void)</td></tr>
<tr class="memdesc:a2726152217119a3709b66d25ab7795c9"><td class="mdescLeft"> </td><td class="mdescRight">This function is called just after a user-defined transition effect has executed. <br /></td></tr>
<tr class="separator:a2726152217119a3709b66d25ab7795c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32d961d94b4b5fe9a852f4fb06183944"><td class="memItemLeft" align="right" valign="top"><a id="a32d961d94b4b5fe9a852f4fb06183944" name="a32d961d94b4b5fe9a852f4fb06183944"></a>
void </td><td class="memItemRight" valign="bottom"><b>enterState</b> (int)</td></tr>
<tr class="separator:a32d961d94b4b5fe9a852f4fb06183944"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a416d63524b37e0c9ebad5a943269e8e3"><td class="memItemLeft" align="right" valign="top"><a id="a416d63524b37e0c9ebad5a943269e8e3" name="a416d63524b37e0c9ebad5a943269e8e3"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>enterStateV</b> (void)</td></tr>
<tr class="separator:a416d63524b37e0c9ebad5a943269e8e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb4eee2af42e61b13c16309e414c122e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#afb4eee2af42e61b13c16309e414c122e">rtgStateEntry</a> (void)</td></tr>
<tr class="memdesc:afb4eee2af42e61b13c16309e414c122e"><td class="mdescLeft"> </td><td class="mdescRight">This function is called when the state machine of the capsule instance enters a new state. <br /></td></tr>
<tr class="separator:afb4eee2af42e61b13c16309e414c122e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29eab3f9d6faca8f95c5d2b8ee9f672f"><td class="memItemLeft" align="right" valign="top"><a id="a29eab3f9d6faca8f95c5d2b8ee9f672f" name="a29eab3f9d6faca8f95c5d2b8ee9f672f"></a>
void </td><td class="memItemRight" valign="bottom"><b>exitState</b> (const RTStateId parent[])</td></tr>
<tr class="separator:a29eab3f9d6faca8f95c5d2b8ee9f672f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3f84dec5bbbb7fb811873b885bfa0c3"><td class="memItemLeft" align="right" valign="top"><a id="ac3f84dec5bbbb7fb811873b885bfa0c3" name="ac3f84dec5bbbb7fb811873b885bfa0c3"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>exitStateV</b> (void)</td></tr>
<tr class="separator:ac3f84dec5bbbb7fb811873b885bfa0c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd208864e9c09eb67f0334b7002273f7"><td class="memItemLeft" align="right" valign="top"><a id="afd208864e9c09eb67f0334b7002273f7" name="afd208864e9c09eb67f0334b7002273f7"></a>
void </td><td class="memItemRight" valign="bottom"><b>processHistory</b> (void)</td></tr>
<tr class="separator:afd208864e9c09eb67f0334b7002273f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae391675fe079b4b05a42b128161a35b5"><td class="memItemLeft" align="right" valign="top"><a id="ae391675fe079b4b05a42b128161a35b5" name="ae391675fe079b4b05a42b128161a35b5"></a>
void </td><td class="memItemRight" valign="bottom"><b>exitToChainState</b> (int, const RTStateId parent[])</td></tr>
<tr class="separator:ae391675fe079b4b05a42b128161a35b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98352ee238d0a9a151147888c179ed55"><td class="memItemLeft" align="right" valign="top"><a id="a98352ee238d0a9a151147888c179ed55" name="a98352ee238d0a9a151147888c179ed55"></a>
void </td><td class="memItemRight" valign="bottom"><b>initializeAll</b> (void)</td></tr>
<tr class="separator:a98352ee238d0a9a151147888c179ed55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a483104e685ed09f9c84e9cc6928b38e6"><td class="memItemLeft" align="right" valign="top"><a id="a483104e685ed09f9c84e9cc6928b38e6" name="a483104e685ed09f9c84e9cc6928b38e6"></a>
int </td><td class="memItemRight" valign="bottom"><b>removeImport</b> (<a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *, <a class="el" href="class_r_t_controller.html">RTController</a> *initiator)</td></tr>
<tr class="separator:a483104e685ed09f9c84e9cc6928b38e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ee99f55fdfca8bd143929680366bde4"><td class="memItemLeft" align="right" valign="top"><a id="a0ee99f55fdfca8bd143929680366bde4" name="a0ee99f55fdfca8bd143929680366bde4"></a>
void </td><td class="memItemRight" valign="bottom"><b>removeAllImports</b> (<a class="el" href="class_r_t_controller.html">RTController</a> *initiator)</td></tr>
<tr class="separator:a0ee99f55fdfca8bd143929680366bde4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e67c00dd84811f5cc36b5bfe82b968d"><td class="memItemLeft" align="right" valign="top"><a id="a2e67c00dd84811f5cc36b5bfe82b968d" name="a2e67c00dd84811f5cc36b5bfe82b968d"></a>
int </td><td class="memItemRight" valign="bottom"><b>_followIn</b> (<a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &end, int portId, int repIndex, <a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *importer)</td></tr>
<tr class="separator:a2e67c00dd84811f5cc36b5bfe82b968d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1699056a917825496fb24e29164bddbc"><td class="memItemLeft" align="right" valign="top"><a id="a1699056a917825496fb24e29164bddbc" name="a1699056a917825496fb24e29164bddbc"></a>
int </td><td class="memItemRight" valign="bottom"><b>_followOut</b> (<a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &end, int portId, int repIndex)</td></tr>
<tr class="separator:a1699056a917825496fb24e29164bddbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a464bb808615613b860944a1ea5f9263e"><td class="memItemLeft" align="right" valign="top"><a id="a464bb808615613b860944a1ea5f9263e" name="a464bb808615613b860944a1ea5f9263e"></a>
void </td><td class="memItemRight" valign="bottom"><b>_unbind</b> (<a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *importer, <a class="el" href="class_r_t_controller.html">RTController</a> *initiator)</td></tr>
<tr class="separator:a464bb808615613b860944a1ea5f9263e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae11c73d5213d9b063402f65d70c52e3c"><td class="memItemLeft" align="right" valign="top"><a id="ae11c73d5213d9b063402f65d70c52e3c" name="ae11c73d5213d9b063402f65d70c52e3c"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>_predestroy</b> (void)</td></tr>
<tr class="separator:ae11c73d5213d9b063402f65d70c52e3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99fc714d65414511c7355262511aef7f"><td class="memItemLeft" align="right" valign="top">RTController::Error </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor.html#a99fc714d65414511c7355262511aef7f">getError</a> (void) const</td></tr>
<tr class="memdesc:a99fc714d65414511c7355262511aef7f"><td class="mdescLeft"> </td><td class="mdescRight">Get the most recent error that occurred when using the TargetRTS. <br /></td></tr>
<tr class="separator:a99fc714d65414511c7355262511aef7f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ae77cf7255119832170cf43f212eeb560"><td class="memItemLeft" align="right" valign="top"><a id="ae77cf7255119832170cf43f212eeb560" name="ae77cf7255119832170cf43f212eeb560"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTActorRef</b></td></tr>
<tr class="separator:ae77cf7255119832170cf43f212eeb560"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af98b79836140a3cd4e1e4bf56966f0f5"><td class="memItemLeft" align="right" valign="top"><a id="af98b79836140a3cd4e1e4bf56966f0f5" name="af98b79836140a3cd4e1e4bf56966f0f5"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTController</b></td></tr>
<tr class="separator:af98b79836140a3cd4e1e4bf56966f0f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a632282972b0b5f6cd394a261964435e2"><td class="memItemLeft" align="right" valign="top"><a id="a632282972b0b5f6cd394a261964435e2" name="a632282972b0b5f6cd394a261964435e2"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTDebugger</b></td></tr>
<tr class="separator:a632282972b0b5f6cd394a261964435e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91aadf601e2893e151a4bf263315ccd4"><td class="memItemLeft" align="right" valign="top"><a id="a91aadf601e2893e151a4bf263315ccd4" name="a91aadf601e2893e151a4bf263315ccd4"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTMessage</b></td></tr>
<tr class="separator:a91aadf601e2893e151a4bf263315ccd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e75f7ca9efcae5275eb1753b036b30d"><td class="memItemLeft" align="right" valign="top"><a id="a5e75f7ca9efcae5275eb1753b036b30d" name="a5e75f7ca9efcae5275eb1753b036b30d"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTProtocol</b></td></tr>
<tr class="separator:a5e75f7ca9efcae5275eb1753b036b30d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An instance of this class represents a capsule instance. </p>
<p>All classes that are generated for capsules inherit from this class. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_r_t_actor_id.html" title="An object that identifies a capsule instance at run-time.">RTActorId</a> is a wrapper object around an <a class="el" href="class_r_t_actor.html" title="An instance of this class represents a capsule instance.">RTActor</a> pointer and hence also represents a capsule instance </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9eb1ab141a21096ca16c4e1596fe0854" name="a9eb1ab141a21096ca16c4e1596fe0854"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9eb1ab141a21096ca16c4e1596fe0854">◆ </a></span>RTActor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTActor::RTActor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_controller.html">RTController</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Never create a capsule instance directly using the new operator. Always create a capsule instance using <a class="el" href="class_frame_1_1_base.html#a07be3539821c3a830ed3239adfccfed6" title="Incarnates a capsule by creating an instance of the capsule in an optional capsule part.">Frame::Base::incarnate()</a>, or automatically at start-up by means of fixed capsule parts. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aed6931db977ea5d6cf6002d7b094f9e2" name="aed6931db977ea5d6cf6002d7b094f9e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed6931db977ea5d6cf6002d7b094f9e2">◆ </a></span>context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_controller.html">RTController</a> * RTActor::context </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the controller which runs this capsule instance. </p>
<dl class="section return"><dt>Returns</dt><dd>The controller object which runs this capsule instance. </dd></dl>
</div>
</div>
<a id="a195ae09e6f66d9a4f307d838f4bc633b" name="a195ae09e6f66d9a4f307d838f4bc633b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a195ae09e6f66d9a4f307d838f4bc633b">◆ </a></span>defaultClass()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="struct_r_t_actor_class.html">RTActorClass</a> * RTActor::defaultClass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> & </td>
<td class="paramname"><em>component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>repIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Get the default capsule class for a capsule part contained in the capsule instance. </p>
<p>This function is used by the <a class="el" href="struct_frame.html" title="Represents the predefined "Frame" protocol.">Frame</a> service when incarnating capsules without specifying the capsule type. The default implementation just returns the capsule that types the capsule part. You may override the function to use a different capsule as the default capsule class. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">component</td><td>A capsule part of the capsule instance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">repIndex</td><td>The index within the capsule part where the <a class="el" href="struct_frame.html" title="Represents the predefined "Frame" protocol.">Frame</a> service will insert the capsule instance to be created. It is unused in the default implementation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The default capsule class for the capsule part. </dd></dl>
</div>
</div>
<a id="aacd08da765f7c39f775971057bc5a39a" name="aacd08da765f7c39f775971057bc5a39a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacd08da765f7c39f775971057bc5a39a">◆ </a></span>defaultController()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_r_t_controller.html">RTController</a> * RTActor::defaultController </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> & </td>
<td class="paramname"><em>component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>repIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Get the default controller for a capsule part contained in the capsule instance. </p>
<p>This function is used by the <a class="el" href="struct_frame.html" title="Represents the predefined "Frame" protocol.">Frame</a> service when incarnating capsules without specifying the controller to run the created capsule instance. The default implementation just returns the controller of this capsule instance. You may override the function to use a different controller as the default. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">component</td><td>A capsule part of the capsule instance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">repIndex</td><td>The index within the capsule part where the <a class="el" href="struct_frame.html" title="Represents the predefined "Frame" protocol.">Frame</a> service will insert the capsule instance to be created. It is unused in the default implementation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The default controller for the capsule part. </dd></dl>
</div>
</div>
<a id="a9970639cb3dbc0d7a77c57f60fcae59b" name="a9970639cb3dbc0d7a77c57f60fcae59b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9970639cb3dbc0d7a77c57f60fcae59b">◆ </a></span>getActorData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="struct_r_t_actor__class.html">RTActor_class</a> * RTActor::getActorData </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get information (meta data) about the capsule, such as its name, ports, states etc. </p>
<p>This information is static and comes from the definition of the capsule. </p><dl class="section return"><dt>Returns</dt><dd>Information about the capsule. </dd></dl>
<p>Implemented in <a class="el" href="class_r_t_super_actor.html#ad158fe76a221bd85973e0167278d7880">RTSuperActor</a>, and <a class="el" href="class_r_t_timer_actor.html#a3c98903aadf63a3da9bcb7b410dd1549">RTTimerActor</a>.</p>
</div>
</div>
<a id="a643273b1669ca63ca8c1c1026a1da77f" name="a643273b1669ca63ca8c1c1026a1da77f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a643273b1669ca63ca8c1c1026a1da77f">◆ </a></span>getCurrentState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::getCurrentState </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the numeric id of the currently active state in the capsule state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>The id of the currently active state. </dd></dl>
</div>
</div>
<a id="ad639bcde16f0d542877bf0aaf6688769" name="ad639bcde16f0d542877bf0aaf6688769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad639bcde16f0d542877bf0aaf6688769">◆ </a></span>getCurrentStateString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTActor::getCurrentStateString </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the currently active state in the capsule state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the currently active state. </dd></dl>
</div>
</div>
<a id="a99fc714d65414511c7355262511aef7f" name="a99fc714d65414511c7355262511aef7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99fc714d65414511c7355262511aef7f">◆ </a></span>getError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RTController::Error RTActor::getError </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the most recent error that occurred when using the TargetRTS. </p>
<p>Call this function immediately after a function has returned with an error code to find out more information about the error that occurred. </p><dl class="section return"><dt>Returns</dt><dd>An RTController::Error value describing the error that occurred most recently when using the TargetRTS. </dd></dl>
</div>
</div>
<a id="ad302b969014411874fb126de958c11fd" name="ad302b969014411874fb126de958c11fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad302b969014411874fb126de958c11fd">◆ </a></span>getHistory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::getHistory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the numeric id of the previously active state in the capsule state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>The id of the state that was most previously active. </dd></dl>
</div>
</div>
<a id="afda516f64e3f5af79d7514a70c73ae12" name="afda516f64e3f5af79d7514a70c73ae12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afda516f64e3f5af79d7514a70c73ae12">◆ </a></span>getId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::getId </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the numeric id for the capsule part that contains this capsule instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A numeric id for the container capsule part that is unique within the capsule </dd></dl>
</div>
</div>
<a id="a940c3401d6050526c0f43bce28c22b95" name="a940c3401d6050526c0f43bce28c22b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a940c3401d6050526c0f43bce28c22b95">◆ </a></span>getIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::getIndex </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated). </p>
<dl class="section return"><dt>Returns</dt><dd>A zero-based index. </dd></dl>
</div>
</div>
<a id="a8e7fcb9e60ed9f8e9aa3acc4fde319e8" name="a8e7fcb9e60ed9f8e9aa3acc4fde319e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e7fcb9e60ed9f8e9aa3acc4fde319e8">◆ </a></span>getMsg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_r_t_message.html">RTMessage</a> * RTActor::getMsg </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the message which is currently being processed by the capsule instance. </p>
<dl class="section return"><dt>Returns</dt><dd>The currently processed message. </dd></dl>
</div>
</div>
<a id="a7bb3738e9b1c8d810e6cbab96305e73e" name="a7bb3738e9b1c8d810e6cbab96305e73e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb3738e9b1c8d810e6cbab96305e73e">◆ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTActor::getName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the capsule part that contains this capsule instance. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the container capsule part. For the top capsule instance the string "Top" is returned. </dd></dl>
</div>
</div>
<a id="a2fbb7d06ff8917ebf2fe9aa5506a4dd1" name="a2fbb7d06ff8917ebf2fe9aa5506a4dd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fbb7d06ff8917ebf2fe9aa5506a4dd1">◆ </a></span>getNumStates()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::getNumStates </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of states in the capsule state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of state machine states. </dd></dl>
</div>
</div>
<a id="ac53c20a187b69a8cbfcd32784dfee8a0" name="ac53c20a187b69a8cbfcd32784dfee8a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac53c20a187b69a8cbfcd32784dfee8a0">◆ </a></span>getReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> * RTActor::getReference </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the capsule part that contains this capsule instance (the capsule part where it was incarnated). </p>
<dl class="section return"><dt>Returns</dt><dd>The container capsule part. </dd></dl>
</div>
</div>
<a id="a35e84411e86127d6d3a12d8bc3cd0087" name="a35e84411e86127d6d3a12d8bc3cd0087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35e84411e86127d6d3a12d8bc3cd0087">◆ </a></span>getStateString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTActor::getStateString </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of one of the states in the capsule state machine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The numeric identifier of a state. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the specified state. An error string is returned in case of error (for example if an invalid state id is specified). </dd></dl>
</div>
</div>
<a id="a01c745d5874c0345a910ae7c389746be" name="a01c745d5874c0345a910ae7c389746be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01c745d5874c0345a910ae7c389746be">◆ </a></span>getTypeName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTActor::getTypeName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the capsule. </p>
<dl class="section return"><dt>Returns</dt><dd>Name of the capsule instance type. </dd></dl>
</div>
</div>
<a id="aa654235fd395c0c56f1f706b99a33cfe" name="aa654235fd395c0c56f1f706b99a33cfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa654235fd395c0c56f1f706b99a33cfe">◆ </a></span>index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::index </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated). </p>
<dl class="section return"><dt>Returns</dt><dd>A 1-based index. </dd></dl>
</div>
</div>
<a id="a633724e6bb61aef8f59ea07fe21a11d8" name="a633724e6bb61aef8f59ea07fe21a11d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a633724e6bb61aef8f59ea07fe21a11d8">◆ </a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::isActive </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if this capsule instance is currently active, i.e. </p>
<p>is processing a message. </p><dl class="section return"><dt>Returns</dt><dd>1 if the capsule instance is active, 0 otherwise. </dd></dl>
</div>
</div>
<a id="ae4d48aa9ccc5919d8804740b785e93bc" name="ae4d48aa9ccc5919d8804740b785e93bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4d48aa9ccc5919d8804740b785e93bc">◆ </a></span>isSameType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::isSameType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_r_t_actor_class.html">RTActorClass</a> * </td>
<td class="paramname"><em>cap</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the type of this capsule instance is a particular capsule type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cap</td><td>A capsule type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the type of this capsule instance equals the capsule type, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a4290a978236d714a248ba073a1fe72f7" name="a4290a978236d714a248ba073a1fe72f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4290a978236d714a248ba073a1fe72f7">◆ </a></span>isType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTActor::isType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a lexical comparison between the name of the capsule with a specified string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>A string to compare the capsule name with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if the capsule type name equals the string. A negative or positive value is returned depending on the result of comparing the first character that is different. </dd></dl>
</div>
</div>
<a id="a67fc8760790c667bdbae0d2005738f4e" name="a67fc8760790c667bdbae0d2005738f4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67fc8760790c667bdbae0d2005738f4e">◆ </a></span>logMsg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RTActor::logMsg </td>
<td>(</td>
<td class="paramtype">void </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>This function is called just before a received message is processed by the capsule instance. </p>
<p>The default implementation prints a message to the log (depending on the current debug level). Override this function to perform any other general action before a message is processed. </p>
</div>
</div>
<a id="aa2e612ad1f62469bf5564641813c4e71" name="aa2e612ad1f62469bf5564641813c4e71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2e612ad1f62469bf5564641813c4e71">◆ </a></span>messageReceivedBeforeInitialized()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RTActor::messageReceivedBeforeInitialized </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called if a message is dispatched to the capsule instance, before its initial transition has executed. </p>
<p>The default behavior is to defer such messages, and recall them when executing the initial transition, to give the capsule instance a chance to handle them. You may override this function to provide a different behavior, for example to call <a class="el" href="class_r_t_actor.html#ae43a356192a2f2dbb920d9252f5f872d" title="This function is called when a message is dispatched to the capsule instance, and when there is no en...">unexpectedMessage()</a> in case you don't expect this scenario to occur. </p>
</div>
</div>
<a id="a83ae2b2d3cf3fceee994496bbb7a147d" name="a83ae2b2d3cf3fceee994496bbb7a147d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83ae2b2d3cf3fceee994496bbb7a147d">◆ </a></span>rtgChainBegin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RTActor::rtgChainBegin </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>origin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>trans</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called at the beginning of every generated chain function that corresponds to a transition in the state machine. </p>
<p>The parameters identifies the start of the transition chain. Note that the first argument is implied by the second, but skipping it would require generation of a mapping table which, on some architectures, could be larger than the code which passes the argument. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>Identifies the start point of the chain. Numbers from 1 to <a class="el" href="class_r_t_actor.html#a2fbb7d06ff8917ebf2fe9aa5506a4dd1" title="Get the number of states in the capsule state machine.">getNumStates()</a>, inclusive, refer to states, larger numbers refer to choice-points. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">trans</td><td>The name of the transition. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afb4eee2af42e61b13c16309e414c122e" name="afb4eee2af42e61b13c16309e414c122e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb4eee2af42e61b13c16309e414c122e">◆ </a></span>rtgStateEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RTActor::rtgStateEntry </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called when the state machine of the capsule instance enters a new state. </p>
<p>The call is made immediately after the state has become active, before the entry action of that state executes. The default implementation of this function does nothing. The function can be overridden on a capsule that wants to perform some common actions whenever a new state in its state machine becomes active. To override this function, simply add a new operation to the capsule with the same name and prototype. </p>
</div>
</div>
<a id="ab318ad0d3a0510da89da3d7858cdaa74" name="ab318ad0d3a0510da89da3d7858cdaa74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab318ad0d3a0510da89da3d7858cdaa74">◆ </a></span>rtsBehavior()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RTActor::rtsBehavior </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em> </td>
</tr>