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

269 lines
19 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_data 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="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html">base_data</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="../../dd/d50/struct_o_t_p_1_1_layer_1_1base__data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OTP::Layer::base_data Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html" title="The base_data struct.">base_data</a> struct.
<a href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#details">More...</a></p>
<p><code>#include &lt;base.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OTP::Layer::base_data:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/df7/struct_o_t_p_1_1_layer_1_1base__data__inherit__graph.png" border="0" usemap="#a_o_t_p_1_1_layer_1_1base__data_inherit__map" alt="Inheritance graph"/></div>
<map name="a_o_t_p_1_1_layer_1_1base__data_inherit__map" id="a_o_t_p_1_1_layer_1_1base__data_inherit__map">
<area shape="rect" title="The base_data struct." alt="" coords="9,169,166,196"/>
<area shape="rect" href="../../d2/d61/struct_o_t_p_1_1_p_d_u_1_1pdu__data.html" title="The pdu_data struct." alt="" coords="14,95,161,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:a9821b32b161937f81f3ba85ec371059b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a9821b32b161937f81f3ba85ec371059b">streamSize</a> () const override</td></tr>
<tr class="memdesc:a9821b32b161937f81f3ba85ec371059b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a9821b32b161937f81f3ba85ec371059b" title="base_data::streamSize">base_data::streamSize</a> <a href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a9821b32b161937f81f3ba85ec371059b">More...</a><br /></td></tr>
<tr class="separator:a9821b32b161937f81f3ba85ec371059b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5423f7db2bc0afa448a36b07bbed9ad8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5423f7db2bc0afa448a36b07bbed9ad8">iStream</a> (PDU::Stream) override</td></tr>
<tr class="memdesc:a5423f7db2bc0afa448a36b07bbed9ad8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5423f7db2bc0afa448a36b07bbed9ad8" title="base_data::iStream">base_data::iStream</a> <a href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5423f7db2bc0afa448a36b07bbed9ad8">More...</a><br /></td></tr>
<tr class="separator:a5423f7db2bc0afa448a36b07bbed9ad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45a83d0592a67073ae9a582db3086b6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a45a83d0592a67073ae9a582db3086b6c">oStream</a> (PDU::Stream) const override</td></tr>
<tr class="memdesc:a45a83d0592a67073ae9a582db3086b6c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a45a83d0592a67073ae9a582db3086b6c" title="base_data::oStream">base_data::oStream</a> <a href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a45a83d0592a67073ae9a582db3086b6c">More...</a><br /></td></tr>
<tr class="separator:a45a83d0592a67073ae9a582db3086b6c"><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:ab6c225924751cb4726b3694252a95e2e"><td class="memItemLeft" align="right" valign="top"><a id="ab6c225924751cb4726b3694252a95e2e"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#ab6c225924751cb4726b3694252a95e2e">footer_options</a></td></tr>
<tr class="memdesc:ab6c225924751cb4726b3694252a95e2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">footer options <br /></td></tr>
<tr class="separator:ab6c225924751cb4726b3694252a95e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a490e2072076f27191725f9e176493769"><td class="memItemLeft" align="right" valign="top"><a id="a490e2072076f27191725f9e176493769"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a490e2072076f27191725f9e176493769">footer_length</a></td></tr>
<tr class="memdesc:a490e2072076f27191725f9e176493769"><td class="mdescLeft">&#160;</td><td class="mdescRight">footer length <br /></td></tr>
<tr class="separator:a490e2072076f27191725f9e176493769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbe8b07761db48b8eead6320244f61dd"><td class="memItemLeft" align="right" valign="top"><a id="abbe8b07761db48b8eead6320244f61dd"></a>
<a class="el" href="../../dc/da6/class_u_u_i_d_1_1uuid.html">UUID::uuid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#abbe8b07761db48b8eead6320244f61dd">cid</a></td></tr>
<tr class="memdesc:abbe8b07761db48b8eead6320244f61dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">component UUID <br /></td></tr>
<tr class="separator:abbe8b07761db48b8eead6320244f61dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39745ed010f536dadc1d3be7413db2a4"><td class="memItemLeft" align="right" valign="top"><a id="a39745ed010f536dadc1d3be7413db2a4"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a39745ed010f536dadc1d3be7413db2a4">folio_number</a></td></tr>
<tr class="memdesc:a39745ed010f536dadc1d3be7413db2a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">folio number <br /></td></tr>
<tr class="separator:a39745ed010f536dadc1d3be7413db2a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2707fcdf86ef6c23f6be7df30b590510"><td class="memItemLeft" align="right" valign="top"><a id="a2707fcdf86ef6c23f6be7df30b590510"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a2707fcdf86ef6c23f6be7df30b590510">page</a></td></tr>
<tr class="memdesc:a2707fcdf86ef6c23f6be7df30b590510"><td class="mdescLeft">&#160;</td><td class="mdescRight">current number <br /></td></tr>
<tr class="separator:a2707fcdf86ef6c23f6be7df30b590510"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bd10e918fa4e73bd0d970ffc4f972b9"><td class="memItemLeft" align="right" valign="top"><a id="a6bd10e918fa4e73bd0d970ffc4f972b9"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a6bd10e918fa4e73bd0d970ffc4f972b9">last_page</a></td></tr>
<tr class="memdesc:a6bd10e918fa4e73bd0d970ffc4f972b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">last page <br /></td></tr>
<tr class="separator:a6bd10e918fa4e73bd0d970ffc4f972b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c12810a2430fd0fad4a95aefaa66af"><td class="memItemLeft" align="right" valign="top"><a id="a00c12810a2430fd0fad4a95aefaa66af"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a00c12810a2430fd0fad4a95aefaa66af">options</a></td></tr>
<tr class="memdesc:a00c12810a2430fd0fad4a95aefaa66af"><td class="mdescLeft">&#160;</td><td class="mdescRight">options <br /></td></tr>
<tr class="separator:a00c12810a2430fd0fad4a95aefaa66af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18296881b3b3eaf3d190eac0829a1e49"><td class="memItemLeft" align="right" valign="top"><a id="a18296881b3b3eaf3d190eac0829a1e49"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a18296881b3b3eaf3d190eac0829a1e49">reserved</a></td></tr>
<tr class="memdesc:a18296881b3b3eaf3d190eac0829a1e49"><td class="mdescLeft">&#160;</td><td class="mdescRight">reserved <br /></td></tr>
<tr class="separator:a18296881b3b3eaf3d190eac0829a1e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cfe74e1891f3a175b6f033216f75e69"><td class="memItemLeft" align="right" valign="top"><a id="a5cfe74e1891f3a175b6f033216f75e69"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5cfe74e1891f3a175b6f033216f75e69">name</a></td></tr>
<tr class="memdesc:a5cfe74e1891f3a175b6f033216f75e69"><td class="mdescLeft">&#160;</td><td class="mdescRight">name <br /></td></tr>
<tr class="separator:a5cfe74e1891f3a175b6f033216f75e69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b71c4367f382cb3400e2344e48e804c"><td class="memItemLeft" align="right" valign="top"><a id="a5b71c4367f382cb3400e2344e48e804c"></a>
PDU::Pdu&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5b71c4367f382cb3400e2344e48e804c">payload</a></td></tr>
<tr class="memdesc:a5b71c4367f382cb3400e2344e48e804c"><td class="mdescLeft">&#160;</td><td class="mdescRight">next PDU <br /></td></tr>
<tr class="separator:a5b71c4367f382cb3400e2344e48e804c"><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="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html" title="The base_data struct.">base_data</a> struct. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5423f7db2bc0afa448a36b07bbed9ad8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5423f7db2bc0afa448a36b07bbed9ad8">&#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_data::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="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a5423f7db2bc0afa448a36b07bbed9ad8" title="base_data::iStream">base_data::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>
</div>
<a id="a45a83d0592a67073ae9a582db3086b6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a83d0592a67073ae9a582db3086b6c">&#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_data::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="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a45a83d0592a67073ae9a582db3086b6c" title="base_data::oStream">base_data::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>
</div>
<a id="a9821b32b161937f81f3ba85ec371059b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9821b32b161937f81f3ba85ec371059b">&#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_data::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><a class="el" href="../../d3/d2a/struct_o_t_p_1_1_layer_1_1base__data.html#a9821b32b161937f81f3ba85ec371059b" title="base_data::streamSize">base_data::streamSize</a> </p>
<dl class="section return"><dt>Returns</dt><dd></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>
</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