code-realtime/docs-sources/targetrts-api/class_r_t_actor_factory_interface.html at main · secure-dev-ops/code-realtime · GitHub

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
<!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: RTActorFactoryInterface 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&amp;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&amp;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="#pub-methods">Public Member Functions</a> &#124;
<a href="class_r_t_actor_factory_interface-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">RTActorFactoryInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule part.
 <a href="class_r_t_actor_factory_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_r_t_actor_factory_interface_8h_source.html">RTActorFactoryInterface.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RTActorFactoryInterface:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_r_t_actor_factory_interface.png" usemap="#RTActorFactoryInterface_map" alt=""/>
  <map id="RTActorFactoryInterface_map" name="RTActorFactoryInterface_map">
<area href="class_r_t_actor_factory.html" title="A capsule factory where capsule instances are created by means of a provided &#39;create&#39; function,..." alt="RTActorFactory" shape="rect" coords="0,56,243,80"/>
<area href="class_r_t_default_actor_factory.html" title="A capsule factory with a default implementation for how to create and destroy capsule instances." alt="RTDefaultActorFactory&lt; CapsuleClass &gt;" shape="rect" coords="253,56,496,80"/>
<area href="class_r_t_default_actor_factory___no_create.html" title="A capsule factory with a default destroy implementation, but without a create implementation (the cre..." alt="RTDefaultActorFactory_NoCreate" shape="rect" coords="506,56,749,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:aff088a5b336b5ea1f6aab416c90e3a65"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_r_t_actor.html">RTActor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor_factory_interface.html#aff088a5b336b5ea1f6aab416c90e3a65">create</a> (<a class="el" href="class_r_t_controller.html">RTController</a> *rts, <a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *ref, int index)=0</td></tr>
<tr class="memdesc:aff088a5b336b5ea1f6aab416c90e3a65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part.  <br /></td></tr>
<tr class="separator:aff088a5b336b5ea1f6aab416c90e3a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89cc48612d95e944ca0ce74b0601c2d8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_actor_factory_interface.html#a89cc48612d95e944ca0ce74b0601c2d8">destroy</a> (<a class="el" href="class_r_t_actor.html">RTActor</a> *actor)=0</td></tr>
<tr class="memdesc:a89cc48612d95e944ca0ce74b0601c2d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by the TargetRTS to destroy a capsule instance.  <br /></td></tr>
<tr class="separator:a89cc48612d95e944ca0ce74b0601c2d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule part. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aff088a5b336b5ea1f6aab416c90e3a65" name="aff088a5b336b5ea1f6aab416c90e3a65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff088a5b336b5ea1f6aab416c90e3a65">&#9670;&#160;</a></span>create()</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_actor.html">RTActor</a> * RTActorFactoryInterface::create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_r_t_controller.html">RTController</a> *&#160;</td>
          <td class="paramname"><em>rts</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_r_t_actor_ref.html">RTActorRef</a> *&#160;</td>
          <td class="paramname"><em>ref</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">rts</td><td>The controller that would run the new capsule instance by default </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The capsule part where the created instance will later be inserted </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index within the capsule part where the instance will later be inserted </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The created capsule instance, ready to be inserted into the capsule part. If nullptr is returned the TargetRTS will use the capsule's RTActorCreator for creating the instance. </dd></dl>

<p>Implemented in <a class="el" href="class_r_t_actor_factory.html#a58c49deb45a29f180b88d8e376fcef18">RTActorFactory</a>, <a class="el" href="class_r_t_default_actor_factory.html#ac54e50080ecbb7d655c28178b6f81dd2">RTDefaultActorFactory&lt; CapsuleClass &gt;</a>, and <a class="el" href="class_r_t_default_actor_factory___no_create.html#a0190566263d571781456031672b801bb">RTDefaultActorFactory_NoCreate</a>.</p>

</div>
</div>
<a id="a89cc48612d95e944ca0ce74b0601c2d8" name="a89cc48612d95e944ca0ce74b0601c2d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89cc48612d95e944ca0ce74b0601c2d8">&#9670;&#160;</a></span>destroy()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void RTActorFactoryInterface::destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_r_t_actor.html">RTActor</a> *&#160;</td>
          <td class="paramname"><em>actor</em></td><td>)</td>
          <td></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>Called by the TargetRTS to destroy a capsule instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>Capsule instance to be destroyed </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="class_r_t_actor_factory.html#a70f1f74e2f1552f8991d775f0875a726">RTActorFactory</a>, <a class="el" href="class_r_t_default_actor_factory.html#a56545a540d37567fbd7ac2c5d823b60f">RTDefaultActorFactory&lt; CapsuleClass &gt;</a>, and <a class="el" href="class_r_t_default_actor_factory___no_create.html#a1b2a6441f02fcda708ed2acfbea4fa17">RTDefaultActorFactory_NoCreate</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_r_t_actor_factory_interface_8h_source.html">RTActorFactoryInterface.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>