deploy: cbb682f

versions/main/_component_8hpp_source.html

@@ -99,7 +99,7 @@
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  <span class="keyword">explicit</span> <a class="code hl_class" href="classmodulo__components_1_1_component.html">Component</a>(<span class="keyword">const</span> rclcpp::NodeOptions&amp; node_options, <span class="keyword">const</span> std::string&amp; fallback_name = <span class="stringliteral">&quot;Component&quot;</span>);</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
-<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classmodulo__components_1_1_component.html#a3973cf9c0bb9df9e21fb11fae1f8898f">   37</a></span>  <span class="keyword">virtual</span> <a class="code hl_function" href="classmodulo__components_1_1_component.html#a3973cf9c0bb9df9e21fb11fae1f8898f">~Component</a>() = <span class="keywordflow">default</span>;</div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>  <span class="keyword">virtual</span> <a class="code hl_function" href="classmodulo__components_1_1_component.html#a38b0fe134b7fc9b802902e009683dc04">~Component</a>();</div>
 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="keyword">protected</span>:</div>
 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  [[nodiscard]] std::shared_ptr&lt;state_representation::ParameterInterface&gt; <a class="code hl_function" href="classmodulo__components_1_1_component.html#a2b02cb1ed0716c4911df78b6735d297e">get_parameter</a>(<span class="keyword">const</span> std::string&amp; name) <span class="keyword">const</span>;</div>
@@ -217,12 +217,12 @@
 <div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>}<span class="comment">// namespace modulo_components</span></div>
 </div>
 <div class="ttc" id="aclassmodulo__components_1_1_component_html"><div class="ttname"><a href="classmodulo__components_1_1_component.html">modulo_components::Component</a></div><div class="ttdoc">A wrapper for rclcpp::Node to simplify application composition through unified component interfaces.</div><div class="ttdef"><b>Definition</b> <a href="_component_8hpp_source.html#l00023">Component.hpp:23</a></div></div>
-<div class="ttc" id="aclassmodulo__components_1_1_component_html_a2b02cb1ed0716c4911df78b6735d297e"><div class="ttname"><a href="classmodulo__components_1_1_component.html#a2b02cb1ed0716c4911df78b6735d297e">modulo_components::Component::get_parameter</a></div><div class="ttdeci">std::shared_ptr&lt; state_representation::ParameterInterface &gt; get_parameter(const std::string &amp;name) const</div><div class="ttdoc">Get a parameter by name.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00061">Component.cpp:61</a></div></div>
-<div class="ttc" id="aclassmodulo__components_1_1_component_html_a3973cf9c0bb9df9e21fb11fae1f8898f"><div class="ttname"><a href="classmodulo__components_1_1_component.html#a3973cf9c0bb9df9e21fb11fae1f8898f">modulo_components::Component::~Component</a></div><div class="ttdeci">virtual ~Component()=default</div><div class="ttdoc">Virtual default destructor.</div></div>
-<div class="ttc" id="aclassmodulo__components_1_1_component_html_aa91321e421f2f71a9c86f694996baeb1"><div class="ttname"><a href="classmodulo__components_1_1_component.html#aa91321e421f2f71a9c86f694996baeb1">modulo_components::Component::on_execute_callback</a></div><div class="ttdeci">virtual bool on_execute_callback()</div><div class="ttdoc">Execute the component logic. To be redefined in derived classes.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00057">Component.cpp:57</a></div></div>
+<div class="ttc" id="aclassmodulo__components_1_1_component_html_a2b02cb1ed0716c4911df78b6735d297e"><div class="ttname"><a href="classmodulo__components_1_1_component.html#a2b02cb1ed0716c4911df78b6735d297e">modulo_components::Component::get_parameter</a></div><div class="ttdeci">std::shared_ptr&lt; state_representation::ParameterInterface &gt; get_parameter(const std::string &amp;name) const</div><div class="ttdoc">Get a parameter by name.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00067">Component.cpp:67</a></div></div>
+<div class="ttc" id="aclassmodulo__components_1_1_component_html_a38b0fe134b7fc9b802902e009683dc04"><div class="ttname"><a href="classmodulo__components_1_1_component.html#a38b0fe134b7fc9b802902e009683dc04">modulo_components::Component::~Component</a></div><div class="ttdeci">virtual ~Component()</div><div class="ttdoc">Destructor that joins the thread if necessary.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00021">Component.cpp:21</a></div></div>
+<div class="ttc" id="aclassmodulo__components_1_1_component_html_aa91321e421f2f71a9c86f694996baeb1"><div class="ttname"><a href="classmodulo__components_1_1_component.html#aa91321e421f2f71a9c86f694996baeb1">modulo_components::Component::on_execute_callback</a></div><div class="ttdeci">virtual bool on_execute_callback()</div><div class="ttdoc">Execute the component logic. To be redefined in derived classes.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00063">Component.cpp:63</a></div></div>
 <div class="ttc" id="aclassmodulo__components_1_1_component_html_ab475ee0e8ea1b1f52c6f0720a0546e90"><div class="ttname"><a href="classmodulo__components_1_1_component.html#ab475ee0e8ea1b1f52c6f0720a0546e90">modulo_components::Component::add_output</a></div><div class="ttdeci">void add_output(const std::string &amp;signal_name, const std::shared_ptr&lt; DataT &gt; &amp;data, const std::string &amp;default_topic=&quot;&quot;, bool fixed_topic=false, bool publish_on_step=true)</div><div class="ttdoc">Add and configure an output signal of the component.</div><div class="ttdef"><b>Definition</b> <a href="_component_8hpp_source.html#l00104">Component.hpp:104</a></div></div>
-<div class="ttc" id="aclassmodulo__components_1_1_component_html_acf7ee62988ef80d58294ed5514885f7e"><div class="ttname"><a href="classmodulo__components_1_1_component.html#acf7ee62988ef80d58294ed5514885f7e">modulo_components::Component::raise_error</a></div><div class="ttdeci">void raise_error() override</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00065">Component.cpp:65</a></div></div>
-<div class="ttc" id="aclassmodulo__components_1_1_component_html_aeb496916cb46a1e8369412f06c440910"><div class="ttname"><a href="classmodulo__components_1_1_component.html#aeb496916cb46a1e8369412f06c440910">modulo_components::Component::execute</a></div><div class="ttdeci">void execute()</div><div class="ttdoc">Start the execution thread.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00033">Component.cpp:33</a></div></div>
+<div class="ttc" id="aclassmodulo__components_1_1_component_html_acf7ee62988ef80d58294ed5514885f7e"><div class="ttname"><a href="classmodulo__components_1_1_component.html#acf7ee62988ef80d58294ed5514885f7e">modulo_components::Component::raise_error</a></div><div class="ttdeci">void raise_error() override</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00071">Component.cpp:71</a></div></div>
+<div class="ttc" id="aclassmodulo__components_1_1_component_html_aeb496916cb46a1e8369412f06c440910"><div class="ttname"><a href="classmodulo__components_1_1_component.html#aeb496916cb46a1e8369412f06c440910">modulo_components::Component::execute</a></div><div class="ttdeci">void execute()</div><div class="ttdoc">Start the execution thread.</div><div class="ttdef"><b>Definition</b> <a href="_component_8cpp_source.html#l00039">Component.cpp:39</a></div></div>
 <div class="ttc" id="aclassmodulo__components_1_1_component_interface_html"><div class="ttname"><a href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></div><div class="ttdoc">Base interface class for modulo components to wrap a ROS Node with custom behaviour.</div><div class="ttdef"><b>Definition</b> <a href="_component_interface_8hpp_source.html#l00056">ComponentInterface.hpp:56</a></div></div>
 <div class="ttc" id="aclassmodulo__components_1_1_component_interface_html_a0bdfeacb7b0b13c2adeecb51a80a0fa0"><div class="ttname"><a href="classmodulo__components_1_1_component_interface.html#a0bdfeacb7b0b13c2adeecb51a80a0fa0">modulo_components::ComponentInterface::publish_outputs</a></div><div class="ttdeci">void publish_outputs()</div><div class="ttdoc">Helper function to publish all output signals.</div><div class="ttdef"><b>Definition</b> <a href="_component_interface_8cpp_source.html#l00586">ComponentInterface.cpp:586</a></div></div>
 <div class="ttc" id="aclassmodulo__components_1_1_component_interface_html_a3e7358644fd89bf60facc34ec5a22646"><div class="ttname"><a href="classmodulo__components_1_1_component_interface.html#a3e7358644fd89bf60facc34ec5a22646">modulo_components::ComponentInterface::outputs_</a></div><div class="ttdeci">std::map&lt; std::string, std::shared_ptr&lt; modulo_core::communication::PublisherInterface &gt; &gt; outputs_</div><div class="ttdoc">Map of outputs.</div><div class="ttdef"><b>Definition</b> <a href="_component_interface_8hpp_source.html#l00446">ComponentInterface.hpp:446</a></div></div>

versions/main/classmodulo__components_1_1_component-members.html

@@ -127,7 +127,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html#a8b5da2215ad8971dedddd82881136499">set_predicate</a>(const std::string &amp;predicate_name, const std::function&lt; bool(void)&gt; &amp;predicate_function)</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html#aa21a3ebb9bdce8d012558a46b4642fb4">set_qos</a>(const rclcpp::QoS &amp;qos)</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html#a6460ddfe54a6cdf5c52edcec86658f3f">trigger</a>(const std::string &amp;trigger_name)</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classmodulo__components_1_1_component.html#a3973cf9c0bb9df9e21fb11fae1f8898f">~Component</a>()=default</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component.html">modulo_components::Component</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classmodulo__components_1_1_component.html#a38b0fe134b7fc9b802902e009683dc04">~Component</a>()</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component.html">modulo_components::Component</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html#a46c675cd5a9b7e00455d86d949950c2f">~ComponentInterface</a>()</td><td class="entry"><a class="el" href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->

versions/main/classmodulo__components_1_1_component.html

@@ -101,10 +101,9 @@
 <tr class="memitem:ae19b0377e0b7fa7f43efff7adfae143b" id="r_ae19b0377e0b7fa7f43efff7adfae143b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmodulo__components_1_1_component.html#ae19b0377e0b7fa7f43efff7adfae143b">Component</a> (<a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">const</a> rclcpp::NodeOptions &amp;<a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">node_options</a>, <a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">const</a> std::string &amp;<a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">fallback_name</a>=&quot;Component&quot;)</td></tr>
 <tr class="memdesc:ae19b0377e0b7fa7f43efff7adfae143b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from node options.  <br /></td></tr>
 <tr class="separator:ae19b0377e0b7fa7f43efff7adfae143b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a3973cf9c0bb9df9e21fb11fae1f8898f" id="r_a3973cf9c0bb9df9e21fb11fae1f8898f"><td class="memItemLeft" align="right" valign="top"><a id="a3973cf9c0bb9df9e21fb11fae1f8898f" name="a3973cf9c0bb9df9e21fb11fae1f8898f"></a>
-<a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><b>~Component</b> ()=<a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">default</a></td></tr>
-<tr class="memdesc:a3973cf9c0bb9df9e21fb11fae1f8898f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual default destructor. <br /></td></tr>
-<tr class="separator:a3973cf9c0bb9df9e21fb11fae1f8898f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a38b0fe134b7fc9b802902e009683dc04" id="r_a38b0fe134b7fc9b802902e009683dc04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmodulo__components_1_1_component.html#a38b0fe134b7fc9b802902e009683dc04">~Component</a> ()</td></tr>
+<tr class="memdesc:a38b0fe134b7fc9b802902e009683dc04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor that joins the thread if necessary.  <br /></td></tr>
+<tr class="separator:a38b0fe134b7fc9b802902e009683dc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classmodulo__components_1_1_component_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmodulo__components_1_1_component_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classmodulo__components_1_1_component_interface.html">modulo_components::ComponentInterface</a></td></tr>
 <tr class="memitem:a46c675cd5a9b7e00455d86d949950c2f inherit pub_methods_classmodulo__components_1_1_component_interface" id="r_a46c675cd5a9b7e00455d86d949950c2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmodulo__components_1_1_component_interface.html#a418d23ed978018d9d465b9036db3eb8d">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmodulo__components_1_1_component_interface.html#a46c675cd5a9b7e00455d86d949950c2f">~ComponentInterface</a> ()</td></tr>
 <tr class="memdesc:a46c675cd5a9b7e00455d86d949950c2f inherit pub_methods_classmodulo__components_1_1_component_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <br /></td></tr>
@@ -347,6 +346,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae19b0377e0b7fa7f43efff7a
 
 <p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00008">8</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
 
+</div>
+</div>
+<a id="a38b0fe134b7fc9b802902e009683dc04" name="a38b0fe134b7fc9b802902e009683dc04"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a38b0fe134b7fc9b802902e009683dc04">&#9670;&#160;</a></span>~Component()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">modulo_components::Component::~Component </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Destructor that joins the thread if necessary. </p>
+
+<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00021">21</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
+
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
@@ -451,7 +479,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aeb496916cb46a1e8369412f0
 
 <p>Start the execution thread. </p>
 
-<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00033">33</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00039">39</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
 
 </div>
 </div>
@@ -494,7 +522,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2b02cb1ed0716c4911df78b6
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The ParameterInterface pointer to a Parameter instance   </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00061">61</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00067">67</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
 
 </div>
 </div>
@@ -524,7 +552,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa91321e421f2f71a9c86f694
 <p>Execute the component logic. To be redefined in derived classes. </p>
 <dl class="section return"><dt>Returns</dt><dd>True, if the execution was successful, false otherwise </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00057">57</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00063">63</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
 
 </div>
 </div>
@@ -554,7 +582,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#acf7ee62988ef80d58294ed55
 
 <p>Reimplemented from <a class="el" href="classmodulo__components_1_1_component_interface.html#a8a1c3bac0aa2141b33682059b3b8f18b">modulo_components::ComponentInterface</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00065">65</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_component_8cpp_source.html#l00071">71</a> of file <a class="el" href="_component_8cpp_source.html">Component.cpp</a>.</p>
 
 </div>
 </div>