official/OpenLCP
1
0
Fork 0
Code Releases 1 Activity
ce74d93cad
OpenLCP/docs/doxygen/html/d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html
Kevin Matz ce74d93cad doxygen built files
2021-08-25 17:21:45 -04:00

304 lines
16 KiB
HTML
Raw Blame History

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenLCP: ACN::DMP::range Struct 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenLCP
&#160;<span id="projectnumber">0.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ACN</b></li><li class="navelem"><b>DMP</b></li><li class="navelem"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html">range</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d3/deb/struct_a_c_n_1_1_d_m_p_1_1range-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ACN::DMP::range Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>5.1.5 The range struct
<a href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#details">More...</a></p>
<p><code>#include &lt;dmp.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ACN::DMP::range:</div>
<div class="dyncontent">
<div class="center"><img src="../../de/d54/struct_a_c_n_1_1_d_m_p_1_1range__inherit__graph.png" border="0" usemap="#a_a_c_n_1_1_d_m_p_1_1range_inherit__map" alt="Inheritance graph"/></div>
<map name="a_a_c_n_1_1_d_m_p_1_1range_inherit__map" id="a_a_c_n_1_1_d_m_p_1_1range_inherit__map">
<area shape="rect" title="5.1.5 The range struct" alt="" coords="23,95,152,121"/>
<area shape="rect" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html" title="The pdu_stream_object struct." alt="" coords="5,5,169,47"/>
</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:a99d1431a4471ae74cb74e4ed31ff9108"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a99d1431a4471ae74cb74e4ed31ff9108">range</a> (const data_type t, const address_length l)</td></tr>
<tr class="memdesc:a99d1431a4471ae74cb74e4ed31ff9108"><td class="mdescLeft">&#160;</td><td class="mdescRight">range <a href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a99d1431a4471ae74cb74e4ed31ff9108">More...</a><br /></td></tr>
<tr class="separator:a99d1431a4471ae74cb74e4ed31ff9108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a446639432c0fc510c78293f4759c3f23"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a446639432c0fc510c78293f4759c3f23">streamSize</a> () const override</td></tr>
<tr class="memdesc:a446639432c0fc510c78293f4759c3f23"><td class="mdescLeft">&#160;</td><td class="mdescRight">streamSize <a href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a446639432c0fc510c78293f4759c3f23">More...</a><br /></td></tr>
<tr class="separator:a446639432c0fc510c78293f4759c3f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af975635a86b544e35d1c725ddbe5fbaf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#af975635a86b544e35d1c725ddbe5fbaf">iStream</a> (PDU::Stream) override</td></tr>
<tr class="memdesc:af975635a86b544e35d1c725ddbe5fbaf"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#af975635a86b544e35d1c725ddbe5fbaf" title="range::iStream">range::iStream</a> <a href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#af975635a86b544e35d1c725ddbe5fbaf">More...</a><br /></td></tr>
<tr class="separator:af975635a86b544e35d1c725ddbe5fbaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a478120d2402cc60ef9c3ef8eeabccd9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a478120d2402cc60ef9c3ef8eeabccd9d">oStream</a> (PDU::Stream) const override</td></tr>
<tr class="memdesc:a478120d2402cc60ef9c3ef8eeabccd9d"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a478120d2402cc60ef9c3ef8eeabccd9d" title="range::oStream">range::oStream</a> <a href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a478120d2402cc60ef9c3ef8eeabccd9d">More...</a><br /></td></tr>
<tr class="separator:a478120d2402cc60ef9c3ef8eeabccd9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a70e4801f91c6278b618a0682ef4f5031"><td class="memItemLeft" align="right" valign="top"><a id="a70e4801f91c6278b618a0682ef4f5031"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a70e4801f91c6278b618a0682ef4f5031">address</a> = 0</td></tr>
<tr class="memdesc:a70e4801f91c6278b618a0682ef4f5031"><td class="mdescLeft">&#160;</td><td class="mdescRight">start address <br /></td></tr>
<tr class="separator:a70e4801f91c6278b618a0682ef4f5031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c08c1a5822cbd31b81b7a8edaa4b88"><td class="memItemLeft" align="right" valign="top"><a id="a44c08c1a5822cbd31b81b7a8edaa4b88"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a44c08c1a5822cbd31b81b7a8edaa4b88">incriment</a> = 0</td></tr>
<tr class="memdesc:a44c08c1a5822cbd31b81b7a8edaa4b88"><td class="mdescLeft">&#160;</td><td class="mdescRight">property size (number of octets) <br /></td></tr>
<tr class="separator:a44c08c1a5822cbd31b81b7a8edaa4b88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03f91bd6590860b926ff299fd5e36b52"><td class="memItemLeft" align="right" valign="top"><a id="a03f91bd6590860b926ff299fd5e36b52"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a03f91bd6590860b926ff299fd5e36b52">count</a> = 0</td></tr>
<tr class="memdesc:a03f91bd6590860b926ff299fd5e36b52"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of properties <br /></td></tr>
<tr class="separator:a03f91bd6590860b926ff299fd5e36b52"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>5.1.5 The range struct </p>
<p>TODO: maybe template this struct based on address_length </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a99d1431a4471ae74cb74e4ed31ff9108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99d1431a4471ae74cb74e4ed31ff9108">&#9670;&nbsp;</a></span>range()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ACN::DMP::range::range </td>
<td>(</td>
<td class="paramtype">const data_type&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const address_length&#160;</td>
<td class="paramname"><em>l</em>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>range </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td></td></tr>
<tr><td class="paramname">l</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af975635a86b544e35d1c725ddbe5fbaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af975635a86b544e35d1c725ddbe5fbaf">&#9670;&nbsp;</a></span>iStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ACN::DMP::range::iStream </td>
<td>(</td>
<td class="paramtype">PDU::Stream&#160;</td>
<td class="paramname"><em>stream</em></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><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#af975635a86b544e35d1c725ddbe5fbaf" title="range::iStream">range::iStream</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#acaa5e9ee7ddce7c11749b231369fb454">ACN::PDU::pdu_stream_object</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_af975635a86b544e35d1c725ddbe5fbaf_icgraph.png" border="0" usemap="#ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_af975635a86b544e35d1c725ddbe5fbaf_icgraph" alt=""/></div>
<map name="ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_af975635a86b544e35d1c725ddbe5fbaf_icgraph" id="ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_af975635a86b544e35d1c725ddbe5fbaf_icgraph">
<area shape="rect" title="range::iStream" alt="" coords="224,13,407,39"/>
<area shape="rect" href="../../d8/d98/struct_a_c_n_1_1_d_m_p_1_1address__pair__list.html#a44d00e36b0d3f71e5c30e295aa54a71c" title="address_pair_list::iStream" alt="" coords="5,5,176,47"/>
</map>
</div>
</div>
</div>
<a id="a478120d2402cc60ef9c3ef8eeabccd9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a478120d2402cc60ef9c3ef8eeabccd9d">&#9670;&nbsp;</a></span>oStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ACN::DMP::range::oStream </td>
<td>(</td>
<td class="paramtype">PDU::Stream&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td> const</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><a class="el" href="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range.html#a478120d2402cc60ef9c3ef8eeabccd9d" title="range::oStream">range::oStream</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#a78127230fabad6aa07d507eb7540822a">ACN::PDU::pdu_stream_object</a>.</p>
</div>
</div>
<a id="a446639432c0fc510c78293f4759c3f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a446639432c0fc510c78293f4759c3f23">&#9670;&nbsp;</a></span>streamSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t ACN::DMP::range::streamSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>streamSize </p>
<dl class="section return"><dt>Returns</dt><dd>length (count of octets) on the wire </dd></dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#a511b8fe623f70d9220f315451e896b34">ACN::PDU::pdu_stream_object</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_a446639432c0fc510c78293f4759c3f23_icgraph.png" border="0" usemap="#ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_a446639432c0fc510c78293f4759c3f23_icgraph" alt=""/></div>
<map name="ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_a446639432c0fc510c78293f4759c3f23_icgraph" id="ad3/d6d/struct_a_c_n_1_1_d_m_p_1_1range_a446639432c0fc510c78293f4759c3f23_icgraph">
<area shape="rect" title="streamSize" alt="" coords="224,46,427,73"/>
<area shape="rect" href="../../d8/d98/struct_a_c_n_1_1_d_m_p_1_1address__pair__list.html#aba4069d10df8629433b77f285312871e" title="dmp_set_data::streamSize" alt="" coords="5,5,176,47"/>
<area shape="rect" href="../../d3/d1e/struct_a_c_n_1_1_d_m_p_1_1address__list.html#a306af0286a4216e77131cd6b71052787" title="address_list::streamSize" alt="" coords="7,71,174,112"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/dmp/dmp.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/dmp/dmp.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
View Git Blame Copy Permalink