Files
lighthub/docs/html/classabstract_ch.html
2020-11-21 20:01:02 +03:00

444 lines
20 KiB
HTML

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LightHub: abstractCh 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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classabstract_ch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">abstractCh Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="abstractch_8h_source.html">abstractch.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for abstractCh:</div>
<div class="dyncontent">
<div class="center"><img src="classabstract_ch__inherit__graph.png" border="0" usemap="#aabstract_ch_inherit__map" alt="Inheritance graph"/></div>
<map name="abstract_ch_inherit__map" id="aabstract_ch_inherit__map">
<area shape="rect" title=" " alt="" coords="224,5,311,32"/>
<area shape="rect" href="classabstract_in.html" title=" " alt="" coords="115,80,195,107"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="334,80,425,107"/>
<area shape="rect" href="classin__ccs811.html" title=" " alt="" coords="5,155,87,181"/>
<area shape="rect" href="classin__hdc1080.html" title=" " alt="" coords="111,155,199,181"/>
<area shape="rect" href="classcolor_channel.html" title=" " alt="" coords="223,155,322,181"/>
<area shape="rect" href="classout___a_c.html" title=" " alt="" coords="346,155,413,181"/>
<area shape="rect" href="classout___modbus.html" title=" " alt="" coords="437,155,530,181"/>
<area shape="rect" href="classout___motor.html" title=" " alt="" coords="554,155,634,181"/>
<area shape="rect" href="classout__dmx.html" title=" " alt="" coords="139,229,211,256"/>
<area shape="rect" href="classout__pwm.html" title=" " alt="" coords="235,229,310,256"/>
<area shape="rect" href="classout___s_p_i_led.html" title=" " alt="" coords="334,229,425,256"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8f13aa9c0f6749f7f064d1930667aaed"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58f34f5341674622c30f5c005ceadead"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a58f34f5341674622c30f5c005ceadead">~abstractCh</a> ()</td></tr>
<tr class="separator:a58f34f5341674622c30f5c005ceadead"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a044156a4dc4ca38d3e731b7df23d058a"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf6346625245be1774a6d27d9cece4e"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e75f5b76a25accdb1de0c936951a93f"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7b6f4586412a13f8f6ac08061e5ae0"><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>
<tr class="separator:afb7b6f4586412a13f8f6ac08061e5ae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefb8821172a2e66f49ea0da9b7c205a5"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#aefb8821172a2e66f49ea0da9b7c205a5">Status</a> ()</td></tr>
<tr class="separator:aefb8821172a2e66f49ea0da9b7c205a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4f1da04403789b710ca3929c57af9d32"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">publishTopic</a> (const char *topic, long value, const char *subtopic=NULL)</td></tr>
<tr class="separator:a4f1da04403789b710ca3929c57af9d32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac24cfc96e7efabae120799b7a23680c6"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#ac24cfc96e7efabae120799b7a23680c6">publishTopic</a> (const char *topic, float value, const char *subtopic=NULL)</td></tr>
<tr class="separator:ac24cfc96e7efabae120799b7a23680c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9404148b9515bd6c1e167a235d844cb8"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a9404148b9515bd6c1e167a235d844cb8">publishTopic</a> (const char *topic, const char *value, const char *subtopic=NULL)</td></tr>
<tr class="separator:a9404148b9515bd6c1e167a235d844cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8f13aa9c0f6749f7f064d1930667aaed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f13aa9c0f6749f7f064d1930667aaed">&#9670;&nbsp;</a></span>abstractCh()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstractCh::abstractCh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a58f34f5341674622c30f5c005ceadead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58f34f5341674622c30f5c005ceadead">&#9670;&nbsp;</a></span>~abstractCh()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual abstractCh::~abstractCh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2e75f5b76a25accdb1de0c936951a93f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e75f5b76a25accdb1de0c936951a93f">&#9670;&nbsp;</a></span>Anounce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractCh::Anounce </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a044156a4dc4ca38d3e731b7df23d058a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a044156a4dc4ca38d3e731b7df23d058a">&#9670;&nbsp;</a></span>Poll()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractCh::Poll </td>
<td>(</td>
<td class="paramtype">short&#160;</td>
<td class="paramname"><em>cause</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>Implemented in <a class="el" href="classout___s_p_i_led.html#a8566a7b80d1a132c00dbaf989880649c">out_SPILed</a>, <a class="el" href="classout__pwm.html#a88c460e7ba29e5b068a2defa395cae2c">out_pwm</a>, <a class="el" href="classout___motor.html#a7a98c58b6c32cc20b7b05ad07a07c231">out_Motor</a>, <a class="el" href="classout___modbus.html#aec6803a6033403f8ac4038236cac5cd9">out_Modbus</a>, <a class="el" href="classout__dmx.html#a0b1d943e9772bf10487010040b948e8a">out_dmx</a>, <a class="el" href="classout___a_c.html#a40fd702a4d9d621c19bfa140c905e64b">out_AC</a>, <a class="el" href="classin__hdc1080.html#a94cf44b2a347e2ee295fad5798f7ef54">in_hdc1080</a>, and <a class="el" href="classin__ccs811.html#a8b57db4521730e66f090a3d6752fd112">in_ccs811</a>.</p>
</div>
</div>
<a id="a9404148b9515bd6c1e167a235d844cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9404148b9515bd6c1e167a235d844cb8">&#9670;&nbsp;</a></span>publishTopic() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int abstractCh::publishTopic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>topic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>subtopic</em> = <code>NULL</code>&#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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac24cfc96e7efabae120799b7a23680c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac24cfc96e7efabae120799b7a23680c6">&#9670;&nbsp;</a></span>publishTopic() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int abstractCh::publishTopic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>topic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>subtopic</em> = <code>NULL</code>&#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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4f1da04403789b710ca3929c57af9d32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f1da04403789b710ca3929c57af9d32">&#9670;&nbsp;</a></span>publishTopic() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int abstractCh::publishTopic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>topic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>subtopic</em> = <code>NULL</code>&#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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aeaf6346625245be1774a6d27d9cece4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaf6346625245be1774a6d27d9cece4e">&#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">virtual int abstractCh::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classout___s_p_i_led.html#adbe9d6b9a2a5e515e9a372a4c4675b15">out_SPILed</a>, <a class="el" href="classout__pwm.html#a0ba3173e9df1cb61b74a705c270ef7b6">out_pwm</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>, <a class="el" href="classout___a_c.html#a3a7b5b20a7d66870551f3dd485e66de2">out_AC</a>, <a class="el" href="classin__hdc1080.html#ae8e077105f9b80dcf682cdc2bd4a95e3">in_hdc1080</a>, and <a class="el" href="classin__ccs811.html#adc24e341d0df945dc9db85051fe03e48">in_ccs811</a>.</p>
</div>
</div>
<a id="aefb8821172a2e66f49ea0da9b7c205a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefb8821172a2e66f49ea0da9b7c205a5">&#9670;&nbsp;</a></span>Status()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractCh::Status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#a9486de18e156758a12fa257f68314e20">out_SPILed</a>, <a class="el" href="classout__pwm.html#a01edf9d010b717601898bf3fddecbc3f">out_pwm</a>, <a class="el" href="classout___motor.html#a47de22f0ce071787ac14a19897337cea">out_Motor</a>, <a class="el" href="classout___modbus.html#acc0fc0ecdb6928cfc7906986b8139780">out_Modbus</a>, <a class="el" href="classout__dmx.html#aa5f2590101b1951f4cf5eb57449d8365">out_dmx</a>, and <a class="el" href="classout___a_c.html#aba0d1953f95f7d04a24582c40cd26196">out_AC</a>.</p>
</div>
</div>
<a id="afb7b6f4586412a13f8f6ac08061e5ae0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb7b6f4586412a13f8f6ac08061e5ae0">&#9670;&nbsp;</a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int abstractCh::Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classout___s_p_i_led.html#a4e24b8a490f8353452b8594dffff8396">out_SPILed</a>, <a class="el" href="classout__pwm.html#a9f3fc73a1fff6ecf991d42564a7b8273">out_pwm</a>, <a class="el" href="classout___motor.html#aafdbaaaf47776dd8c0c5d6bfa32bb3c2">out_Motor</a>, <a class="el" href="classout___modbus.html#a9cb4b395f5f8a6d15dcc429664a4174b">out_Modbus</a>, <a class="el" href="classout__dmx.html#a0b9383e7fe30707142915cbc3d0ec772">out_dmx</a>, and <a class="el" href="classout___a_c.html#a763ace53db4e64692d061db48f396aba">out_AC</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="abstractch_8h_source.html">abstractch.h</a></li>
<li><a class="el" href="abstractch_8cpp.html">abstractch.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
</body>
</html>