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

docs-sources/targetrts-api/_r_t_actor_factory_8h_source.html

@@ -99,14 +99,14 @@
 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#if RTUseCPP11</span></div>
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;functional&gt;</span></div>
-<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">class </span><a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a> final : <span class="keyword">public</span> <a class="code hl_class" href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a> {</div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_r_t_actor_factory.html">   27</a></span><span class="keyword">class </span><a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a> final : <span class="keyword">public</span> <a class="code hl_class" href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a> {</div>
 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>    <a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a>() = <span class="keyword">delete</span>;</div>
 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</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; creator;</div>
 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="keyword">public</span>:</div>
-<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    <a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a>(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="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_r_t_actor_factory.html#a71c62c8a8dd12e7aa075b2bcb34c8359">   35</a></span>    <a class="code hl_function" href="class_r_t_actor_factory.html#a71c62c8a8dd12e7aa075b2bcb34c8359">RTActorFactory</a>(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="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#else</span></div>
 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    <span class="comment">/* An old C++ compiler can compile this code, but not use RTActorFactory */</span></div>
-<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_r_t_actor_factory.html">   38</a></span><span class="keyword">class </span><a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a> {</div>
+<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="keyword">class </span><a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a> {</div>
 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="keyword">public</span>:</div>
 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    <a class="code hl_class" href="class_r_t_actor_factory.html">RTActorFactory</a>();</div>
 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#endif</span></div>
@@ -117,9 +117,10 @@
 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>};</div>
 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#endif </span><span class="comment">// __RTActorFactory_h__</span></div>
-<div class="ttc" id="aclass_r_t_actor_factory_html"><div class="ttname"><a href="class_r_t_actor_factory.html">RTActorFactory</a></div><div class="ttdoc">A capsule factory where capsule instances are created by means of a provided 'create' function,...</div><div class="ttdef"><b>Definition:</b> RTActorFactory.h:38</div></div>
+<div class="ttc" id="aclass_r_t_actor_factory_html"><div class="ttname"><a href="class_r_t_actor_factory.html">RTActorFactory</a></div><div class="ttdoc">A capsule factory where capsule instances are created by means of a provided 'create' function,...</div><div class="ttdef"><b>Definition:</b> RTActorFactory.h:27</div></div>
 <div class="ttc" id="aclass_r_t_actor_factory_html_a58c49deb45a29f180b88d8e376fcef18"><div class="ttname"><a href="class_r_t_actor_factory.html#a58c49deb45a29f180b88d8e376fcef18">RTActorFactory::create</a></div><div class="ttdeci">RTActor * create(RTController *rts, RTActorRef *ref, int index) override</div><div class="ttdoc">Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule par...</div></div>
 <div class="ttc" id="aclass_r_t_actor_factory_html_a70f1f74e2f1552f8991d775f0875a726"><div class="ttname"><a href="class_r_t_actor_factory.html#a70f1f74e2f1552f8991d775f0875a726">RTActorFactory::destroy</a></div><div class="ttdeci">void destroy(RTActor *actor) override</div><div class="ttdoc">Called by the TargetRTS to destroy a capsule instance.</div></div>
+<div class="ttc" id="aclass_r_t_actor_factory_html_a71c62c8a8dd12e7aa075b2bcb34c8359"><div class="ttname"><a href="class_r_t_actor_factory.html#a71c62c8a8dd12e7aa075b2bcb34c8359">RTActorFactory::RTActorFactory</a></div><div class="ttdeci">RTActorFactory(std::function&lt; RTActor *(RTController *, RTActorRef *, int)&gt; createFunc)</div><div class="ttdoc">Create a capsule factory which will use the provided function to implement capsule instance creation.</div></div>
 <div class="ttc" id="aclass_r_t_actor_factory_interface_html"><div class="ttname"><a href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a></div><div class="ttdoc">Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule...</div><div class="ttdef"><b>Definition:</b> RTActorFactoryInterface.h:15</div></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>

docs-sources/targetrts-api/_r_t_actor_ref_8h_source.html

@@ -216,7 +216,7 @@
 <div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="preprocessor">#endif</span></div>
 <div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span> </div>
 <div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="preprocessor">#endif </span><span class="comment">// __RTActorRef_h__</span></div>
-<div class="ttc" id="aclass_r_t_actor_factory_html"><div class="ttname"><a href="class_r_t_actor_factory.html">RTActorFactory</a></div><div class="ttdoc">A capsule factory where capsule instances are created by means of a provided 'create' function,...</div><div class="ttdef"><b>Definition:</b> RTActorFactory.h:38</div></div>
+<div class="ttc" id="aclass_r_t_actor_factory_html"><div class="ttname"><a href="class_r_t_actor_factory.html">RTActorFactory</a></div><div class="ttdoc">A capsule factory where capsule instances are created by means of a provided 'create' function,...</div><div class="ttdef"><b>Definition:</b> RTActorFactory.h:27</div></div>
 <div class="ttc" id="aclass_r_t_actor_factory_interface_html"><div class="ttname"><a href="class_r_t_actor_factory_interface.html">RTActorFactoryInterface</a></div><div class="ttdoc">Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule...</div><div class="ttdef"><b>Definition:</b> RTActorFactoryInterface.h:15</div></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_id_html"><div class="ttname"><a href="class_r_t_actor_id.html">RTActorId</a></div><div class="ttdoc">An object that identifies a capsule instance at run-time.</div><div class="ttdef"><b>Definition:</b> RTActorId.h:27</div></div>

docs-sources/targetrts-api/_r_t_ascii_decoding_8h_source.html

@@ -100,13 +100,13 @@
 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">class  </span><a class="code hl_class" href="class_r_t_data_object.html">RTDataObject</a>;</div>
 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">class  </span><a class="code hl_class" href="class_r_t_i_buffer.html">RTIBuffer</a>;</div>
-<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">struct </span>RTUnknownObject;</div>
+<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">struct </span><a class="code hl_struct" href="struct_r_t_unknown_object.html">RTUnknownObject</a>;</div>
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
-<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">class </span>RTAsciiDecoding : <span class="keyword">public</span> RTDecoding</div>
+<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="class_r_t_ascii_decoding.html">   31</a></span><span class="keyword">class </span><a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_r_t_decoding.html">RTDecoding</a></div>
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>{</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keyword">public</span>:</div>
-<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <span class="keyword">explicit</span>    RTAsciiDecoding( <a class="code hl_class" href="class_r_t_i_buffer.html">RTIBuffer</a> * );</div>
-<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    <span class="keyword">virtual</span>     ~RTAsciiDecoding( <span class="keywordtype">void</span> );</div>
+<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <span class="keyword">explicit</span>    <a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a>( <a class="code hl_class" href="class_r_t_i_buffer.html">RTIBuffer</a> * );</div>
+<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    <span class="keyword">virtual</span>     <a class="code hl_class" href="class_r_t_ascii_decoding.html">~RTAsciiDecoding</a>( <span class="keywordtype">void</span> );</div>
 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    <span class="comment">// All the get/put functions return an int which is non-zero</span></div>
 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>    <span class="comment">// if the operation was successful. Otherwise, the following</span></div>
@@ -163,7 +163,7 @@
 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    <span class="keywordtype">int</span>                 getArray( <span class="keywordtype">void</span> *, <span class="keywordtype">int</span>, <span class="keyword">const</span> <a class="code hl_struct" href="struct_r_t_object__class.html">RTObject_class</a> * );</div>
 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>    <span class="keywordtype">int</span>                 getAddress ( <span class="keywordtype">void</span> * &amp; );</div>
 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>    <span class="keywordtype">int</span>                 getName( <span class="keywordtype">char</span> * value, <span class="keywordtype">int</span> length );</div>
-<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>    RTUnknownObject   * getUnknown( <span class="keyword">const</span> <span class="keywordtype">char</span> * );</div>
+<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>    <a class="code hl_struct" href="struct_r_t_unknown_object.html">RTUnknownObject</a>   * getUnknown( <span class="keyword">const</span> <span class="keywordtype">char</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>    <span class="keywordtype">int</span>                 getNonWhite( <span class="keywordtype">char</span> &amp; );</div>
 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="keywordtype">int</span>                 getByte( <span class="keywordtype">char</span> &amp; );</div>
@@ -182,17 +182,20 @@
 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    <a class="code hl_class" href="class_r_t_i_buffer.html">RTIBuffer</a>         * input;</div>
 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span> </div>
 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>    <span class="comment">// unavailable methods</span></div>
-<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    RTAsciiDecoding( <span class="keyword">const</span> RTAsciiDecoding &amp; );</div>
-<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>    RTAsciiDecoding &amp; operator=( <span class="keyword">const</span> RTAsciiDecoding &amp; );</div>
+<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    <a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a>( <span class="keyword">const</span> <a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a> &amp; );</div>
+<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>    <a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a> &amp; operator=( <span class="keyword">const</span> <a class="code hl_class" href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a> &amp; );</div>
 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>}; <span class="comment">//lint !e1712</span></div>
 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="preprocessor">#endif </span><span class="comment">// OBJECT_DECODE</span></div>
 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span> </div>
 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="preprocessor">#endif </span><span class="comment">// __RTAsciiDecoding_h__</span></div>
+<div class="ttc" id="aclass_r_t_ascii_decoding_html"><div class="ttname"><a href="class_r_t_ascii_decoding.html">RTAsciiDecoding</a></div><div class="ttdoc">The default decoding implementation that is used for all default type descriptors.</div><div class="ttdef"><b>Definition:</b> RTAsciiDecoding.h:32</div></div>
 <div class="ttc" id="aclass_r_t_data_object_html"><div class="ttname"><a href="class_r_t_data_object.html">RTDataObject</a></div><div class="ttdoc">Provides a common interface to certain data type implementations (e.g.</div><div class="ttdef"><b>Definition:</b> RTDataObject.h:33</div></div>
+<div class="ttc" id="aclass_r_t_decoding_html"><div class="ttname"><a href="class_r_t_decoding.html">RTDecoding</a></div><div class="ttdef"><b>Definition:</b> RTDecoding.h:27</div></div>
 <div class="ttc" id="aclass_r_t_i_buffer_html"><div class="ttname"><a href="class_r_t_i_buffer.html">RTIBuffer</a></div><div class="ttdef"><b>Definition:</b> RTIBuffer.h:22</div></div>
 <div class="ttc" id="astruct_r_t_field_descriptor_html"><div class="ttname"><a href="struct_r_t_field_descriptor.html">RTFieldDescriptor</a></div><div class="ttdef"><b>Definition:</b> RTFieldDescriptor.h:40</div></div>
 <div class="ttc" id="astruct_r_t_object__class_html"><div class="ttname"><a href="struct_r_t_object__class.html">RTObject_class</a></div><div class="ttdoc">A type descriptor providing information about a type.</div><div class="ttdef"><b>Definition:</b> RTObject_class.h:64</div></div>
+<div class="ttc" id="astruct_r_t_unknown_object_html"><div class="ttname"><a href="struct_r_t_unknown_object.html">RTUnknownObject</a></div><div class="ttdef"><b>Definition:</b> RTUnknownObject.h:24</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>