OpenLCP/docs/doxygen/html/d6/d1f/struct_r_d_m_1_1_u_i_d.html
2021-08-25 17:21:45 -04:00

323 lines
16 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenLCP: RDM::UID 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"><a class="el" href="../../de/d93/namespace_r_d_m.html">RDM</a></li><li class="navelem"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</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="#friends">Friends</a> &#124;
<a href="../../d5/de7/struct_r_d_m_1_1_u_i_d-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RDM::UID Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html" title="The UID struct.">UID</a> struct.
<a href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#details">More...</a></p>
<p><code>#include &lt;uid.h&gt;</code></p>
<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:a74561760f77253077d334126b3e99d37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a74561760f77253077d334126b3e99d37">UID</a> (uint32_t dev=0, uint16_t man=0, bool flag=false)</td></tr>
<tr class="memdesc:a74561760f77253077d334126b3e99d37"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html" title="The UID struct.">UID</a>. <a href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a74561760f77253077d334126b3e99d37">More...</a><br /></td></tr>
<tr class="separator:a74561760f77253077d334126b3e99d37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c95b0bbc26f6d2b642c5f715faf4a2d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a5c95b0bbc26f6d2b642c5f715faf4a2d">isBroadcast</a> () const</td></tr>
<tr class="memdesc:a5c95b0bbc26f6d2b642c5f715faf4a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">isBroadcast <a href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a5c95b0bbc26f6d2b642c5f715faf4a2d">More...</a><br /></td></tr>
<tr class="separator:a5c95b0bbc26f6d2b642c5f715faf4a2d"><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:a8897c965044ec67d7dad2acd6905949b"><td class="memItemLeft" ><a id="a8897c965044ec67d7dad2acd6905949b"></a>
union {</td></tr>
<tr class="memitem:ae7bd9b63d6b4a6bb32832ba461a30f20"><td class="memItemLeft" >
&#160;&#160;&#160;uint64_t&#160;&#160;&#160;<b>uid</b>: 48</td></tr>
<tr class="separator:ae7bd9b63d6b4a6bb32832ba461a30f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0daec1d0e0d53583c1590aabef6b7bde"><td class="memItemLeft" ><a id="a0daec1d0e0d53583c1590aabef6b7bde"></a>
&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:ad51fcebffc00cd1a332af2e853cd9ef8"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<b>device</b></td></tr>
<tr class="separator:ad51fcebffc00cd1a332af2e853cd9ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9349203ba8cf1cff87a7b915a2bb9f3"><td class="memItemLeft" ><a id="aa9349203ba8cf1cff87a7b915a2bb9f3"></a>
&#160;&#160;&#160;&#160;&#160;&#160;union {</td></tr>
<tr class="memitem:a035b9f1f0ccf8f5d4316ed31579491b1"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<b>manufacturer</b></td></tr>
<tr class="separator:a035b9f1f0ccf8f5d4316ed31579491b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae36acfce49c5b4e159cc853afb1ec0da"><td class="memItemLeft" ><a id="ae36acfce49c5b4e159cc853afb1ec0da"></a>
&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a367c2426a67845183454e58cb1c6fb5f"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<b>esta_man</b>: 15</td></tr>
<tr class="separator:a367c2426a67845183454e58cb1c6fb5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4615075c6e95e7cc8958f3515d013a5b"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;bool&#160;&#160;&#160;<b>flag</b>: 1</td></tr>
<tr class="separator:a4615075c6e95e7cc8958f3515d013a5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae36acfce49c5b4e159cc853afb1ec0da"><td class="memItemLeft" valign="top">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:ae36acfce49c5b4e159cc853afb1ec0da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9349203ba8cf1cff87a7b915a2bb9f3"><td class="memItemLeft" valign="top">&#160;&#160;&#160;&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:aa9349203ba8cf1cff87a7b915a2bb9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0daec1d0e0d53583c1590aabef6b7bde"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a0daec1d0e0d53583c1590aabef6b7bde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8897c965044ec67d7dad2acd6905949b"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a8897c965044ec67d7dad2acd6905949b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a398316eaeec3b6253094d75faec688b6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a398316eaeec3b6253094d75faec688b6">operator==</a> (const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;a, const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;b)</td></tr>
<tr class="memdesc:a398316eaeec3b6253094d75faec688b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">operator == <a href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a398316eaeec3b6253094d75faec688b6">More...</a><br /></td></tr>
<tr class="separator:a398316eaeec3b6253094d75faec688b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a1f1abbe3323f570b2daee3c823508e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a3a1f1abbe3323f570b2daee3c823508e">operator!=</a> (const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;a, const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;b)</td></tr>
<tr class="memdesc:a3a1f1abbe3323f570b2daee3c823508e"><td class="mdescLeft">&#160;</td><td class="mdescRight">operator != <a href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html#a3a1f1abbe3323f570b2daee3c823508e">More...</a><br /></td></tr>
<tr class="separator:a3a1f1abbe3323f570b2daee3c823508e"><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/d1f/struct_r_d_m_1_1_u_i_d.html" title="The UID struct.">UID</a> struct. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a74561760f77253077d334126b3e99d37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74561760f77253077d334126b3e99d37">&#9670;&nbsp;</a></span>UID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RDM::UID::UID </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>dev</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>man</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>flag</em> = <code>false</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html" title="The UID struct.">UID</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td></td></tr>
<tr><td class="paramname">man</td><td></td></tr>
<tr><td class="paramname">flag</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5c95b0bbc26f6d2b642c5f715faf4a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c95b0bbc26f6d2b642c5f715faf4a2d">&#9670;&nbsp;</a></span>isBroadcast()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RDM::UID::isBroadcast </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>isBroadcast </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a3a1f1abbe3323f570b2daee3c823508e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a1f1abbe3323f570b2daee3c823508e">&#9670;&nbsp;</a></span>operator!=</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;&#160;</td>
<td class="paramname"><em>b</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>operator != </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td></td></tr>
<tr><td class="paramname">b</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="a398316eaeec3b6253094d75faec688b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a398316eaeec3b6253094d75faec688b6">&#9670;&nbsp;</a></span>operator==</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">UID</a> &amp;&#160;</td>
<td class="paramname"><em>b</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>operator == </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td></td></tr>
<tr><td class="paramname">b</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/rdm/uid.h</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>