doxigen docs

This commit is contained in:
2022-01-06 02:01:16 +03:00
parent 6fe28695f2
commit 07046680e0
628 changed files with 37077 additions and 10502 deletions

View File

@@ -9,6 +9,10 @@
<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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
@@ -23,7 +27,9 @@
<td id="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
&#160;<span id="projectnumber">v4.0.0</span>
</div>
<div id="projectbrief">Smarthome controller firmware</div>
</td>
</tr>
</tbody>
@@ -46,6 +52,23 @@ $(function() {
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classabstract_out.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -60,7 +83,6 @@ $(function() {
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
@@ -75,29 +97,22 @@ $(function() {
<div class="dynheader">
Inheritance diagram for abstractOut:</div>
<div class="dyncontent">
<div class="center"><img src="classabstract_out__inherit__graph.png" border="0" usemap="#aabstract_out_inherit__map" alt="Inheritance graph"/></div>
<map name="abstract_out_inherit__map" id="aabstract_out_inherit__map">
<area shape="rect" title=" " alt="" coords="252,80,343,107"/>
<area shape="rect" href="classcolor_channel.html" title=" " alt="" coords="89,155,188,181"/>
<area shape="rect" href="classout___a_c.html" title=" " alt="" coords="212,155,279,181"/>
<area shape="rect" href="classout___modbus.html" title=" " alt="" coords="303,155,396,181"/>
<area shape="rect" href="classout___motor.html" title=" " alt="" coords="420,155,500,181"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="254,5,341,32"/>
<area shape="rect" href="classout__dmx.html" title=" " alt="" coords="5,229,77,256"/>
<area shape="rect" href="classout__pwm.html" title=" " alt="" coords="101,229,176,256"/>
<area shape="rect" href="classout___s_p_i_led.html" title=" " alt="" coords="200,229,291,256"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for abstractOut:</div>
<div class="dyncontent">
<div class="center"><img src="classabstract_out__coll__graph.png" border="0" usemap="#aabstract_out_coll__map" alt="Collaboration graph"/></div>
<map name="abstract_out_coll__map" id="aabstract_out_coll__map">
<area shape="rect" title=" " alt="" coords="5,81,96,108"/>
<area shape="rect" href="class_item.html" title=" " alt="" coords="27,171,75,197"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="7,5,94,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="center">
<img src="classabstract_out.png" usemap="#abstractOut_map" alt=""/>
<map id="abstractOut_map" name="abstractOut_map">
<area href="classabstract_ch.html" alt="abstractCh" shape="rect" coords="392,0,480,24"/>
<area href="classcolor_channel.html" alt="colorChannel" shape="rect" coords="98,112,186,136"/>
<area href="classout___a_c.html" alt="out_AC" shape="rect" coords="196,112,284,136"/>
<area href="classout___modbus.html" alt="out_Modbus" shape="rect" coords="294,112,382,136"/>
<area href="classout___motor.html" alt="out_Motor" shape="rect" coords="392,112,480,136"/>
<area href="classout___multivent.html" alt="out_Multivent" shape="rect" coords="490,112,578,136"/>
<area href="classout__pid.html" alt="out_pid" shape="rect" coords="588,112,676,136"/>
<area href="classout__relay.html" alt="out_relay" shape="rect" coords="686,112,774,136"/>
<area href="classout__dmx.html" alt="out_dmx" shape="rect" coords="0,168,88,192"/>
<area href="classout__pwm.html" alt="out_pwm" shape="rect" coords="98,168,186,192"/>
<area href="classout___s_p_i_led.html" alt="out_SPILed" shape="rect" coords="196,168,284,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
@@ -105,12 +120,17 @@ Public Member Functions</h2></td></tr>
<tr class="separator:adec371468752bd5027c282cf933ba035"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacaa5ef80fdc683ef96a4dc80d24692a"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aacaa5ef80fdc683ef96a4dc80d24692a">Ctrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool toExecute=true)=0</td></tr>
<tr class="separator:aacaa5ef80fdc683ef96a4dc80d24692a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec9af01cfc42f385cdf36ce51c8f3387"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aec9af01cfc42f385cdf36ce51c8f3387">isActive</a> ()</td></tr>
<tr class="separator:aec9af01cfc42f385cdf36ce51c8f3387"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedf98f968abc36332dcddb7eab00fe13"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aedf98f968abc36332dcddb7eab00fe13">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:aedf98f968abc36332dcddb7eab00fe13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4d536357ee52043a4d338ce2106350e"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#af4d536357ee52043a4d338ce2106350e">isActive</a> ()</td></tr>
<tr class="separator:af4d536357ee52043a4d338ce2106350e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade514d6b6152e87a70d66932c74e1656"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classitem_cmd.html">itemCmd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#ade514d6b6152e87a70d66932c74e1656">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:ade514d6b6152e87a70d66932c74e1656"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7033b9cda791ad810c4837ed5909f2"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#a3f7033b9cda791ad810c4837ed5909f2">getChanType</a> ()</td></tr>
<tr class="separator:a3f7033b9cda791ad810c4837ed5909f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a786157307bd9438b8fbff24421b95330"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#a786157307bd9438b8fbff24421b95330">getDefaultStorageType</a> ()</td></tr>
<tr class="separator:a786157307bd9438b8fbff24421b95330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad84ffc96dafea9cbe5c91f35c90ffe3b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">Setup</a> () override</td></tr>
<tr class="memdesc:ad84ffc96dafea9cbe5c91f35c90ffe3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove?? Now getChanType used instead. <a href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">More...</a><br /></td></tr>
<tr class="separator:ad84ffc96dafea9cbe5c91f35c90ffe3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classabstract_ch"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classabstract_ch')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classabstract_ch.html">abstractCh</a></td></tr>
<tr class="memitem:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed">abstractCh</a> ()</td></tr>
<tr class="separator:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -118,8 +138,6 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a58f34f5341674622c30f5c005ceadead inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a044156a4dc4ca38d3e731b7df23d058a inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">Poll</a> (short cause)=0</td></tr>
<tr class="separator:a044156a4dc4ca38d3e731b7df23d058a inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf6346625245be1774a6d27d9cece4e inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">Setup</a> ()=0</td></tr>
<tr class="separator:aeaf6346625245be1774a6d27d9cece4e inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e75f5b76a25accdb1de0c936951a93f inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a2e75f5b76a25accdb1de0c936951a93f">Anounce</a> ()</td></tr>
<tr class="separator:a2e75f5b76a25accdb1de0c936951a93f inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7b6f4586412a13f8f6ac08061e5ae0 inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0">Stop</a> ()</td></tr>
@@ -210,7 +228,7 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classout___motor.html#aa731e4d1848e07ac7dc4a99a0ddad942">out_Motor</a>, <a class="el" href="classout___modbus.html#a784be57c40d67b41488b9585fe792019">out_Modbus</a>, <a class="el" href="classout___a_c.html#aeaf2ac4088b2b4b2fd4e1b83755c9964">out_AC</a>, and <a class="el" href="classcolor_channel.html#a9d7354cc266c98067b7b43cbf8707feb">colorChannel</a>.</p>
<p>Implemented in <a class="el" href="classout__relay.html#ac3d7157d14d016e0136b3e4a9aac4aac">out_relay</a>, <a class="el" href="classout__pid.html#a9347f14882001bff3d73ca52c1adc700">out_pid</a>, <a class="el" href="classout___multivent.html#abb99e44bd16433c7fed965197ecde5dd">out_Multivent</a>, <a class="el" href="classout___motor.html#aa731e4d1848e07ac7dc4a99a0ddad942">out_Motor</a>, <a class="el" href="classout___modbus.html#a784be57c40d67b41488b9585fe792019">out_Modbus</a>, <a class="el" href="classout___a_c.html#aeaf2ac4088b2b4b2fd4e1b83755c9964">out_AC</a>, and <a class="el" href="classcolor_channel.html#a9d7354cc266c98067b7b43cbf8707feb">colorChannel</a>.</p>
</div>
</div>
@@ -237,12 +255,12 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#aac304bcdc354a3667ec99d4c06513b72">out_SPILed</a>, <a class="el" href="classout__pwm.html#a54bea9682560aa628f85a532a363d57a">out_pwm</a>, <a class="el" href="classout___motor.html#afd67d9b6e08f14074a236d5222809226">out_Motor</a>, <a class="el" href="classout___modbus.html#a2752cf2376840f3763572963be8785db">out_Modbus</a>, and <a class="el" href="classout__dmx.html#a575351786cdc191555757cd39b4382f5">out_dmx</a>.</p>
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#aac304bcdc354a3667ec99d4c06513b72">out_SPILed</a>, <a class="el" href="classout__relay.html#a94d578704853aaacf7f7f1877de91b62">out_relay</a>, <a class="el" href="classout__pwm.html#a54bea9682560aa628f85a532a363d57a">out_pwm</a>, <a class="el" href="classout__pid.html#abbc665d20d2adf34bece05b8761aca31">out_pid</a>, <a class="el" href="classout___multivent.html#ad5815eb1cb9b4ecf68da3d0bae8b4ce4">out_Multivent</a>, <a class="el" href="classout___motor.html#afd67d9b6e08f14074a236d5222809226">out_Motor</a>, <a class="el" href="classout___modbus.html#a2752cf2376840f3763572963be8785db">out_Modbus</a>, and <a class="el" href="classout__dmx.html#a575351786cdc191555757cd39b4382f5">out_dmx</a>.</p>
</div>
</div>
<a id="aedf98f968abc36332dcddb7eab00fe13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedf98f968abc36332dcddb7eab00fe13">&#9670;&nbsp;</a></span>getDefaultOnVal()</h2>
<a id="ade514d6b6152e87a70d66932c74e1656"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade514d6b6152e87a70d66932c74e1656">&#9670;&nbsp;</a></span>getDefaultOnVal()</h2>
<div class="memitem">
<div class="memproto">
@@ -251,7 +269,7 @@ Additional Inherited Members</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractOut::getDefaultOnVal </td>
<td class="memname">virtual <a class="el" href="classitem_cmd.html">itemCmd</a> abstractOut::getDefaultOnVal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@@ -266,8 +284,8 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
<a id="aec9af01cfc42f385cdf36ce51c8f3387"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec9af01cfc42f385cdf36ce51c8f3387">&#9670;&nbsp;</a></span>isActive()</h2>
<a id="a786157307bd9438b8fbff24421b95330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a786157307bd9438b8fbff24421b95330">&#9670;&nbsp;</a></span>getDefaultStorageType()</h2>
<div class="memitem">
<div class="memproto">
@@ -276,7 +294,7 @@ Additional Inherited Members</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractOut::isActive </td>
<td class="memname">virtual int abstractOut::getDefaultStorageType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@@ -289,7 +307,65 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#ae87041b49ca8c6484a72c3c29955fbfb">out_SPILed</a>, <a class="el" href="classout__pwm.html#a18f9c90ab80a5bf00049e25c2c4657a5">out_pwm</a>, <a class="el" href="classout___motor.html#ac2a224d74421c1a28d34a83779a45bdc">out_Motor</a>, <a class="el" href="classout___modbus.html#a6b94efbbbbea5a4ad3b489dba8f9b268">out_Modbus</a>, <a class="el" href="classout__dmx.html#a691d16146df96df12df763a90cdc6d92">out_dmx</a>, and <a class="el" href="classout___a_c.html#ab2d5debf137c9cc91ce0b58a72da0766">out_AC</a>.</p>
<p>Reimplemented in <a class="el" href="classcolor_channel.html#a52d7b6241409b4e00574b389d3436e1f">colorChannel</a>, <a class="el" href="classout__pid.html#a6555b3173f184d3768e34339d59daa87">out_pid</a>, <a class="el" href="classout___multivent.html#ac02fd9c36c2a3cb5ad7132e2c1df6f61">out_Multivent</a>, <a class="el" href="classout___motor.html#ab1892d3477647b06ed2212dd8e0baaf3">out_Motor</a>, <a class="el" href="classout___modbus.html#a844c63be065d02f2f178399519b03245">out_Modbus</a>, and <a class="el" href="classout___a_c.html#ab249f27bdd0d22a6f098190dc746cd8c">out_AC</a>.</p>
</div>
</div>
<a id="af4d536357ee52043a4d338ce2106350e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4d536357ee52043a4d338ce2106350e">&#9670;&nbsp;</a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int abstractOut::isActive </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>Reimplemented in <a class="el" href="classout__pid.html#aca01ec18698d8406bbe6964322f8ba2d">out_pid</a>, and <a class="el" href="classout___a_c.html#ab2d5debf137c9cc91ce0b58a72da0766">out_AC</a>.</p>
</div>
</div>
<a id="ad84ffc96dafea9cbe5c91f35c90ffe3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad84ffc96dafea9cbe5c91f35c90ffe3b">&#9670;&nbsp;</a></span>Setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int abstractOut::Setup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove?? Now getChanType used instead. </p>
<p>Implements <a class="el" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">abstractCh</a>.</p>
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#adbe9d6b9a2a5e515e9a372a4c4675b15">out_SPILed</a>, <a class="el" href="classout__relay.html#a1858489a8c68a95fa242f9d2ca24ee0d">out_relay</a>, <a class="el" href="classout__pwm.html#a0ba3173e9df1cb61b74a705c270ef7b6">out_pwm</a>, <a class="el" href="classout__pid.html#af67c5acd4858a8b694b5083f5c5f97cb">out_pid</a>, <a class="el" href="classout___multivent.html#a568241c423d7172f2a4b061f88e48341">out_Multivent</a>, <a class="el" href="classout___motor.html#ab9f2b433a4fedd6fec5b9cb504b934f4">out_Motor</a>, <a class="el" href="classout___modbus.html#acf5452aac576901614eca795ab4ca440">out_Modbus</a>, <a class="el" href="classout__dmx.html#a7bf52f6c7ce630f879de60596b82dd87">out_dmx</a>, and <a class="el" href="classout___a_c.html#a3a7b5b20a7d66870551f3dd485e66de2">out_AC</a>.</p>
</div>
</div>
@@ -316,13 +392,18 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="abstractout_8h_source.html">abstractout.h</a></li>
<li><a class="el" href="abstractout_8cpp.html">abstractout.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classabstract_out.html">abstractOut</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>