Merge branch 'main' of github01.hclpnp.com:Modeling/rtistic-pub-doc

Author: mattias-mohlin

docs-sources/targetrts-api/_r_t_injector_8h_source.html

@@ -112,39 +112,36 @@
 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>{</div>
 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="keyword">public</span>:</div>
 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
-<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">   61</a></span>    <span class="keyword">static</span> <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>&amp; <a class="code hl_function" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">getInstance</a>() {</div>
-<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>        <span class="keyword">static</span> <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a> instance;</div>
-<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>        <span class="keywordflow">return</span> instance;</div>
-<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    }</div>
+<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">   61</a></span>    <span class="keyword">static</span> <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>&amp; <a class="code hl_function" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">getInstance</a>();</div>
+<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
+<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>();</div>
+<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    <a class="code hl_class" href="class_r_t_injector.html">~RTInjector</a>();</div>
 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
-<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>    <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>();</div>
-<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    <a class="code hl_class" href="class_r_t_injector.html">~RTInjector</a>();</div>
-<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
-<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">   74</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">registerCreateFunction</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>, std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, <span class="keywordtype">int</span>)&gt; createFunc);</div>
-<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
-<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">   81</a></span>    std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, int)&gt; <a class="code hl_function" href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">getCreateFunction</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>);</div>
-<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
-<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">   92</a></span>    <a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* <a class="code hl_function" href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">create</a>(<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *rts, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *ref, <span class="keywordtype">int</span> index);</div>
+<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">   71</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">registerCreateFunction</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>, std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, <span class="keywordtype">int</span>)&gt; createFunc);</div>
+<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
+<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">   78</a></span>    std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, int)&gt; <a class="code hl_function" href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">getCreateFunction</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>);</div>
+<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
+<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">   89</a></span>    <a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* <a class="code hl_function" href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">create</a>(<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *rts, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *ref, <span class="keywordtype">int</span> index);</div>
+<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span> </div>
+<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>    <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>(<a class="code hl_class" href="class_r_t_injector.html">RTInjector</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
+<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>    <span class="keywordtype">void</span> operator=(<a class="code hl_class" href="class_r_t_injector.html">RTInjector</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span> </div>
-<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>    <a class="code hl_class" href="class_r_t_injector.html">RTInjector</a>(<a class="code hl_class" href="class_r_t_injector.html">RTInjector</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
-<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="keywordtype">void</span> operator=(<a class="code hl_class" href="class_r_t_injector.html">RTInjector</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
-<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
-<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="keyword">private</span>:</div>
-<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
-<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>    std::unordered_map&lt;std::string, std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, int)&gt; &gt; createFuncRegistry;</div>
-<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="preprocessor">#if USE_THREADS</span></div>
-<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>    RTMutex* _mutex;</div>
-<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
-<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>};</div>
-<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
-<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#endif </span><span class="comment">// __RTInjector_h__</span></div>
+<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="keyword">private</span>:</div>
+<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span> </div>
+<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    std::unordered_map&lt;std::string, std::function&lt;<a class="code hl_class" href="class_r_t_actor.html">RTActor</a>* (<a class="code hl_class" href="class_r_t_controller.html">RTController</a> *, <a class="code hl_class" href="class_r_t_actor_ref.html">RTActorRef</a> *, int)&gt; &gt; createFuncRegistry;</div>
+<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="preprocessor">#if USE_THREADS</span></div>
+<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>    RTMutex* _mutex;</div>
+<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
+<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>};</div>
+<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span> </div>
+<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#endif </span><span class="comment">// __RTInjector_h__</span></div>
 <div class="ttc" id="aclass_r_t_actor_html"><div class="ttname"><a href="class_r_t_actor.html">RTActor</a></div><div class="ttdoc">An instance of this class represents a capsule instance.</div><div class="ttdef"><b>Definition:</b> RTActor.h:44</div></div>
 <div class="ttc" id="aclass_r_t_actor_ref_html"><div class="ttname"><a href="class_r_t_actor_ref.html">RTActorRef</a></div><div class="ttdoc">Represents a capsule part.</div><div class="ttdef"><b>Definition:</b> RTActorRef.h:39</div></div>
 <div class="ttc" id="aclass_r_t_controller_html"><div class="ttname"><a href="class_r_t_controller.html">RTController</a></div><div class="ttdoc">A controller manages a group of capsule instances that all run in the same physical thread (i....</div><div class="ttdef"><b>Definition:</b> RTController.h:54</div></div>
 <div class="ttc" id="aclass_r_t_injector_html"><div class="ttname"><a href="class_r_t_injector.html">RTInjector</a></div><div class="ttdoc">Dependency injector for RT applications.</div><div class="ttdef"><b>Definition:</b> RTInjector.h:54</div></div>
 <div class="ttc" id="aclass_r_t_injector_html_a23f2c45bc802443918532174bc4708b0"><div class="ttname"><a href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">RTInjector::create</a></div><div class="ttdeci">RTActor * create(RTController *rts, RTActorRef *ref, int index)</div><div class="ttdoc">Create a capsule instance.</div></div>
-<div class="ttc" id="aclass_r_t_injector_html_a9fa3e0df657b37bd727abfc4943ba3fc"><div class="ttname"><a href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">RTInjector::getInstance</a></div><div class="ttdeci">static RTInjector &amp; getInstance()</div><div class="ttdoc">Access the singleton injector instance (created on first access)</div><div class="ttdef"><b>Definition:</b> RTInjector.h:61</div></div>
+<div class="ttc" id="aclass_r_t_injector_html_a9fa3e0df657b37bd727abfc4943ba3fc"><div class="ttname"><a href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">RTInjector::getInstance</a></div><div class="ttdeci">static RTInjector &amp; getInstance()</div><div class="ttdoc">Access the singleton injector instance (created on first access)</div></div>
 <div class="ttc" id="aclass_r_t_injector_html_aaa9b5ed1aada6e6fa00574b839cde6fe"><div class="ttname"><a href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">RTInjector::getCreateFunction</a></div><div class="ttdeci">std::function&lt; RTActor *(RTController *, RTActorRef *, int)&gt; getCreateFunction(const std::string &amp;id)</div><div class="ttdoc">Get a create function registered for incarnating capsule instances in a capsule part.</div></div>
 <div class="ttc" id="aclass_r_t_injector_html_abb5d5a47f08b8e6b34e07d13abcfe38b"><div class="ttname"><a href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">RTInjector::registerCreateFunction</a></div><div class="ttdeci">void registerCreateFunction(const std::string &amp;id, std::function&lt; RTActor *(RTController *, RTActorRef *, int)&gt; createFunc)</div><div class="ttdoc">Register a create function to be used for incarnating capsule instances in a capsule part.</div></div>
 </div><!-- fragment --></div><!-- contents -->

docs-sources/targetrts-api/_r_t_protocol_8h_source.html

@@ -240,8 +240,8 @@
 <div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span> </div>
 <div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span>        State           state;</div>
 <div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span>        <a class="code hl_class" href="class_r_t_protocol.html">RTProtocol</a>    * remote;</div>
-<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span>        <span class="keywordtype">int</span>             remoteIndex;</div>
-<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span>        <span class="keyword">const</span> <span class="keywordtype">int</span>     * signalMap;</div>
+<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span>        <span class="keyword">const</span> <span class="keywordtype">int</span>     * signalMap;</div>
+<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span>        <span class="keywordtype">int</span>             remoteIndex;</div>
 <div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span> </div>
 <div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span>        <span class="comment">// these are only called after the priority and type are checked</span></div>
 <div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span> </div>
@@ -266,8 +266,8 @@
 <div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span> </div>
 <div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span>    End                    * _ends;</div>
 <div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span>    <span class="keyword">const</span> <a class="code hl_struct" href="struct_r_t_port_descriptor.html">RTPortDescriptor</a> * _info;</div>
-<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>    <span class="keywordtype">int</span>                      _flags;</div>
-<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>    <a class="code hl_class" href="class_r_t_layer_data.html">RTLayerData</a>            * _layer;</div>
+<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>    <a class="code hl_class" href="class_r_t_layer_data.html">RTLayerData</a>            * _layer;</div>
+<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>    <span class="keywordtype">int</span>                      _flags;</div>
 <div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span> </div>
 <div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span>    <span class="comment">// unavailable methods</span></div>
 <div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span>    <a class="code hl_class" href="class_r_t_protocol.html">RTProtocol</a>( <span class="keyword">const</span> <a class="code hl_class" href="class_r_t_protocol.html">RTProtocol</a> &amp; );</div>

docs-sources/targetrts-api/class_r_t_injector-members.html

@@ -77,7 +77,7 @@
 <table class="directory">
   <tr class="even"><td class="entry"><a class="el" href="class_r_t_injector.html#a23f2c45bc802443918532174bc4708b0">create</a>(RTController *rts, RTActorRef *ref, int index)</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="class_r_t_injector.html#aaa9b5ed1aada6e6fa00574b839cde6fe">getCreateFunction</a>(const std::string &amp;id)</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">getInstance</a>()</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_r_t_injector.html#a9fa3e0df657b37bd727abfc4943ba3fc">getInstance</a>()</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>operator=</b>(RTInjector const &amp;)=delete (defined in <a class="el" href="class_r_t_injector.html">RTInjector</a>)</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_r_t_injector.html#abb5d5a47f08b8e6b34e07d13abcfe38b">registerCreateFunction</a>(const std::string &amp;id, std::function&lt; RTActor *(RTController *, RTActorRef *, int)&gt; createFunc)</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"></td></tr>
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>RTInjector</b>() (defined in <a class="el" href="class_r_t_injector.html">RTInjector</a>)</td><td class="entry"><a class="el" href="class_r_t_injector.html">RTInjector</a></td><td class="entry"></td></tr>

docs-sources/targetrts-api/class_r_t_injector.html

@@ -206,7 +206,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9fa3e0df657b37bd727abfc4
       </table>
   </td>
   <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
+<span class="mlabels"><span class="mlabel">static</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">