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

268 lines
17 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: OTP::Layer::base_footer 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>OTP</b></li><li class="navelem"><b>Layer</b></li><li class="navelem"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html">base_footer</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="../../db/d07/struct_o_t_p_1_1_layer_1_1base__footer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OTP::Layer::base_footer Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html" title="The base_footer struct.">base_footer</a> struct.
<a href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#details">More...</a></p>
<p><code>#include &lt;base.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OTP::Layer::base_footer:</div>
<div class="dyncontent">
<div class="center"><img src="../../d5/dc1/struct_o_t_p_1_1_layer_1_1base__footer__inherit__graph.png" border="0" usemap="#a_o_t_p_1_1_layer_1_1base__footer_inherit__map" alt="Inheritance graph"/></div>
<map name="a_o_t_p_1_1_layer_1_1base__footer_inherit__map" id="a_o_t_p_1_1_layer_1_1base__footer_inherit__map">
<area shape="rect" title="The base_footer struct." alt="" coords="5,95,171,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="6,5,170,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:ae3502ba770d275b6e504f2a1e099cc55"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#ae3502ba770d275b6e504f2a1e099cc55">streamSize</a> () const override</td></tr>
<tr class="memdesc:ae3502ba770d275b6e504f2a1e099cc55"><td class="mdescLeft">&#160;</td><td class="mdescRight">streamSize <a href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#ae3502ba770d275b6e504f2a1e099cc55">More...</a><br /></td></tr>
<tr class="separator:ae3502ba770d275b6e504f2a1e099cc55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add02b69678631ee520054152c3177b11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#add02b69678631ee520054152c3177b11">iStream</a> (PDU::Stream) override</td></tr>
<tr class="memdesc:add02b69678631ee520054152c3177b11"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#add02b69678631ee520054152c3177b11" title="base_footer::iStream">base_footer::iStream</a> <a href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#add02b69678631ee520054152c3177b11">More...</a><br /></td></tr>
<tr class="separator:add02b69678631ee520054152c3177b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bceec73360c7d5cd56b62c7151a149a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a8bceec73360c7d5cd56b62c7151a149a">oStream</a> (PDU::Stream) const override</td></tr>
<tr class="memdesc:a8bceec73360c7d5cd56b62c7151a149a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a8bceec73360c7d5cd56b62c7151a149a" title="base_footer::oStream">base_footer::oStream</a> <a href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a8bceec73360c7d5cd56b62c7151a149a">More...</a><br /></td></tr>
<tr class="separator:a8bceec73360c7d5cd56b62c7151a149a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html">ACN::PDU::pdu_stream_object</a></td></tr>
<tr class="memitem:acaa5e9ee7ddce7c11749b231369fb454 inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td class="memItemLeft" align="right" valign="top"><a id="acaa5e9ee7ddce7c11749b231369fb454"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#acaa5e9ee7ddce7c11749b231369fb454">iStream</a> (Stream)=0</td></tr>
<tr class="memdesc:acaa5e9ee7ddce7c11749b231369fb454 inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td class="mdescLeft">&#160;</td><td class="mdescRight">fill structure data from input stream <br /></td></tr>
<tr class="separator:acaa5e9ee7ddce7c11749b231369fb454 inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78127230fabad6aa07d507eb7540822a inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td class="memItemLeft" align="right" valign="top"><a id="a78127230fabad6aa07d507eb7540822a"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#a78127230fabad6aa07d507eb7540822a">oStream</a> (Stream) const =0</td></tr>
<tr class="memdesc:a78127230fabad6aa07d507eb7540822a inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><td class="mdescLeft">&#160;</td><td class="mdescRight">write structure data to output stream <br /></td></tr>
<tr class="separator:a78127230fabad6aa07d507eb7540822a inherit pub_methods_struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object"><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:ac1a8922ce52d125a605807d572b1f893"><td class="memItemLeft" align="right" valign="top"><a id="ac1a8922ce52d125a605807d572b1f893"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#ac1a8922ce52d125a605807d572b1f893">options</a></td></tr>
<tr class="memdesc:ac1a8922ce52d125a605807d572b1f893"><td class="mdescLeft">&#160;</td><td class="mdescRight">options <br /></td></tr>
<tr class="separator:ac1a8922ce52d125a605807d572b1f893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72ff8fb6ee8493260f9915128aa2771f"><td class="memItemLeft" align="right" valign="top"><a id="a72ff8fb6ee8493260f9915128aa2771f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a72ff8fb6ee8493260f9915128aa2771f">length</a></td></tr>
<tr class="memdesc:a72ff8fb6ee8493260f9915128aa2771f"><td class="mdescLeft">&#160;</td><td class="mdescRight">length <br /></td></tr>
<tr class="separator:a72ff8fb6ee8493260f9915128aa2771f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a351b167272dc8106ac9a70afd9b131c8"><td class="memItemLeft" align="right" valign="top"><a id="a351b167272dc8106ac9a70afd9b131c8"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a351b167272dc8106ac9a70afd9b131c8">data</a></td></tr>
<tr class="memdesc:a351b167272dc8106ac9a70afd9b131c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">binary data <br /></td></tr>
<tr class="separator:a351b167272dc8106ac9a70afd9b131c8"><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>The <a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html" title="The base_footer struct.">base_footer</a> struct. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="add02b69678631ee520054152c3177b11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add02b69678631ee520054152c3177b11">&#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 OTP::Layer::base_footer::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> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#add02b69678631ee520054152c3177b11" title="base_footer::iStream">base_footer::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>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_add02b69678631ee520054152c3177b11_icgraph.png" border="0" usemap="#ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_add02b69678631ee520054152c3177b11_icgraph" alt=""/></div>
<map name="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_add02b69678631ee520054152c3177b11_icgraph" id="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_add02b69678631ee520054152c3177b11_icgraph">
<area shape="rect" title="base_footer::iStream" alt="" coords="224,5,389,47"/>
<area shape="rect" href="../../d8/d4c/class_o_t_p_1_1_layer_1_1pdu.html#ad6fc54231c644b745f1a1dd75f5e2c73" title="pdu::iStream" alt="" coords="5,13,176,39"/>
</map>
</div>
</div>
</div>
<a id="a8bceec73360c7d5cd56b62c7151a149a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bceec73360c7d5cd56b62c7151a149a">&#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 OTP::Layer::base_footer::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> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer.html#a8bceec73360c7d5cd56b62c7151a149a" title="base_footer::oStream">base_footer::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>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_a8bceec73360c7d5cd56b62c7151a149a_icgraph.png" border="0" usemap="#ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_a8bceec73360c7d5cd56b62c7151a149a_icgraph" alt=""/></div>
<map name="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_a8bceec73360c7d5cd56b62c7151a149a_icgraph" id="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_a8bceec73360c7d5cd56b62c7151a149a_icgraph">
<area shape="rect" title="base_footer::oStream" alt="" coords="228,5,393,47"/>
<area shape="rect" href="../../d8/d4c/class_o_t_p_1_1_layer_1_1pdu.html#a1ba3fbd08a28fc238c37835e08062e15" title="pdu::oStream" alt="" coords="5,13,180,39"/>
</map>
</div>
</div>
</div>
<a id="ae3502ba770d275b6e504f2a1e099cc55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3502ba770d275b6e504f2a1e099cc55">&#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 OTP::Layer::base_footer::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">inline</span><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="../../d6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_ae3502ba770d275b6e504f2a1e099cc55_icgraph.png" border="0" usemap="#ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_ae3502ba770d275b6e504f2a1e099cc55_icgraph" alt=""/></div>
<map name="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_ae3502ba770d275b6e504f2a1e099cc55_icgraph" id="ad6/d8b/struct_o_t_p_1_1_layer_1_1base__footer_ae3502ba770d275b6e504f2a1e099cc55_icgraph">
<area shape="rect" title="streamSize" alt="" coords="245,23,411,65"/>
<area shape="rect" href="../../d8/d4c/class_o_t_p_1_1_layer_1_1pdu.html#a1ba3fbd08a28fc238c37835e08062e15" title="pdu::oStream" alt="" coords="14,5,189,32"/>
<area shape="rect" href="../../d8/d4c/class_o_t_p_1_1_layer_1_1pdu.html#affe7b9167eda7b6b26a7a3d7b5b6b337" title="pdu::streamSize" alt="" coords="5,56,197,83"/>
</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/otp/base.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/otp/base.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