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

444 lines
38 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: SACN::Universe 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="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>SACN</b></li><li class="navelem"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html">Universe</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dd/daa/class_s_a_c_n_1_1_universe-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SACN::Universe Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html" title="The Universe class.">Universe</a> class.
<a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#details">More...</a></p>
<p><code>#include &lt;universe.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SACN::Universe:</div>
<div class="dyncontent">
<div class="center"><img src="../../d5/d06/class_s_a_c_n_1_1_universe__inherit__graph.png" border="0" usemap="#a_s_a_c_n_1_1_universe_inherit__map" alt="Inheritance graph"/></div>
<map name="a_s_a_c_n_1_1_universe_inherit__map" id="a_s_a_c_n_1_1_universe_inherit__map">
<area shape="rect" title="The Universe class." alt="" coords="76,80,196,107"/>
<area shape="rect" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html" title="The MergeProxyUniverse class 6.2.3.1 Multiple Sources at Highest Priority It is possible for there to..." alt="" coords="41,155,231,181"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html" title="The Universe class." alt="" coords="5,5,117,32"/>
<area shape="rect" href="../../d3/d95/class_a_c_n_1_1_d_m_p_1_1_device.html" title="The ACN::DMP::Device class." alt="" coords="141,5,280,32"/>
</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:af2c6a3cb4fe67ea35393af96fb834d2c"><td class="memItemLeft" align="right" valign="top"><a id="af2c6a3cb4fe67ea35393af96fb834d2c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#af2c6a3cb4fe67ea35393af96fb834d2c">Universe</a> ()</td></tr>
<tr class="memdesc:af2c6a3cb4fe67ea35393af96fb834d2c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#af2c6a3cb4fe67ea35393af96fb834d2c" title="Universe::Universe.">Universe::Universe</a>. <br /></td></tr>
<tr class="separator:af2c6a3cb4fe67ea35393af96fb834d2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a921427bed93ca7fdce20849b87e94989"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a921427bed93ca7fdce20849b87e94989">isSyncronized</a> () const</td></tr>
<tr class="memdesc:a921427bed93ca7fdce20849b87e94989"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a921427bed93ca7fdce20849b87e94989" title="Universe::isSyncronized.">Universe::isSyncronized</a>. <a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a921427bed93ca7fdce20849b87e94989">More...</a><br /></td></tr>
<tr class="separator:a921427bed93ca7fdce20849b87e94989"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77331a84244061551e7da1c9741905e2"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2">source</a> () const</td></tr>
<tr class="memdesc:a77331a84244061551e7da1c9741905e2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2" title="Universe::source.">Universe::source</a>. <a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2">More...</a><br /></td></tr>
<tr class="separator:a77331a84244061551e7da1c9741905e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad19b9643c99434558ad3c0ebc15e3e75"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75">slot</a> (const uint16_t) override</td></tr>
<tr class="memdesc:ad19b9643c99434558ad3c0ebc15e3e75"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75" title="Universe::slot.">Universe::slot</a>. <a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75">More...</a><br /></td></tr>
<tr class="separator:ad19b9643c99434558ad3c0ebc15e3e75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84dc852cb904a72789352860c97c1731"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731">set</a> (std::shared_ptr&lt; <a class="el" href="../../dd/d62/class_a_c_n_1_1_d_m_p_1_1_pdu.html">ACN::DMP::Pdu</a> &gt;, std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt;)</td></tr>
<tr class="memdesc:a84dc852cb904a72789352860c97c1731"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731" title="Universe::set.">Universe::set</a>. <a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731">More...</a><br /></td></tr>
<tr class="separator:a84dc852cb904a72789352860c97c1731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a664f1264c2072e86722f4fef10b9afef"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a664f1264c2072e86722f4fef10b9afef">setProvenance</a> (std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt;)</td></tr>
<tr class="memdesc:a664f1264c2072e86722f4fef10b9afef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Universe::setSource. <a href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a664f1264c2072e86722f4fef10b9afef">More...</a><br /></td></tr>
<tr class="separator:a664f1264c2072e86722f4fef10b9afef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb2e49602ef288ebe2504fcda961d212"><td class="memItemLeft" align="right" valign="top"><a id="adb2e49602ef288ebe2504fcda961d212"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#adb2e49602ef288ebe2504fcda961d212">synchronize</a> ()</td></tr>
<tr class="memdesc:adb2e49602ef288ebe2504fcda961d212"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#adb2e49602ef288ebe2504fcda961d212" title="Universe::synchronize.">Universe::synchronize</a>. <br /></td></tr>
<tr class="separator:adb2e49602ef288ebe2504fcda961d212"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_d_m_x_1_1_universe"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_d_m_x_1_1_universe')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html">DMX::Universe</a></td></tr>
<tr class="memitem:a86b5d8dd6295fbb936b042df4113a9da inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a86b5d8dd6295fbb936b042df4113a9da">Universe</a> (int timeout_period=E111_DATA_LOSS_TIMEOUT)</td></tr>
<tr class="memdesc:a86b5d8dd6295fbb936b042df4113a9da inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a86b5d8dd6295fbb936b042df4113a9da" title="Universe::Universe.">Universe::Universe</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a86b5d8dd6295fbb936b042df4113a9da">More...</a><br /></td></tr>
<tr class="separator:a86b5d8dd6295fbb936b042df4113a9da inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f935a754fd92eb9e690a55ffd7da3c7 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top"><a id="a8f935a754fd92eb9e690a55ffd7da3c7"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a8f935a754fd92eb9e690a55ffd7da3c7">~Universe</a> ()</td></tr>
<tr class="memdesc:a8f935a754fd92eb9e690a55ffd7da3c7 inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a8f935a754fd92eb9e690a55ffd7da3c7" title="Universe::~Universe.">Universe::~Universe</a>. <br /></td></tr>
<tr class="separator:a8f935a754fd92eb9e690a55ffd7da3c7 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a778bff0bcc1bfe43ff8bcf2dccae3a5a inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">virtual const DimmerData *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a778bff0bcc1bfe43ff8bcf2dccae3a5a">data</a> () const</td></tr>
<tr class="memdesc:a778bff0bcc1bfe43ff8bcf2dccae3a5a inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a778bff0bcc1bfe43ff8bcf2dccae3a5a" title="Universe::data.">Universe::data</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a778bff0bcc1bfe43ff8bcf2dccae3a5a">More...</a><br /></td></tr>
<tr class="separator:a778bff0bcc1bfe43ff8bcf2dccae3a5a inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d0c6c197a42c65d2db1ca374b58f811 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a3d0c6c197a42c65d2db1ca374b58f811">rxRate</a> ()</td></tr>
<tr class="memdesc:a3d0c6c197a42c65d2db1ca374b58f811 inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a3d0c6c197a42c65d2db1ca374b58f811" title="Universe::rxRate Rate (in Hz) at which the universe is being recv&#39;d.">Universe::rxRate</a> Rate (in Hz) at which the universe is being recv'd. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a3d0c6c197a42c65d2db1ca374b58f811">More...</a><br /></td></tr>
<tr class="separator:a3d0c6c197a42c65d2db1ca374b58f811 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d1648233d98fc1511dfdb6a77b9c75 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75">setValue</a> (const uint16_t, const uint8_t)</td></tr>
<tr class="memdesc:a53d1648233d98fc1511dfdb6a77b9c75 inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75" title="Universe::setValue.">Universe::setValue</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75">More...</a><br /></td></tr>
<tr class="separator:a53d1648233d98fc1511dfdb6a77b9c75 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc92c3f0a743fd6658d968d68710098 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#adfc92c3f0a743fd6658d968d68710098">setValue</a> (const uint16_t, const uint16_t, const uint8_t *)</td></tr>
<tr class="memdesc:adfc92c3f0a743fd6658d968d68710098 inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75" title="Universe::setValue.">Universe::setValue</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#adfc92c3f0a743fd6658d968d68710098">More...</a><br /></td></tr>
<tr class="separator:adfc92c3f0a743fd6658d968d68710098 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34b4057b238262cf738e9d353ddd2752 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a34b4057b238262cf738e9d353ddd2752">setData</a> (std::vector&lt; uint8_t &gt;)</td></tr>
<tr class="memdesc:a34b4057b238262cf738e9d353ddd2752 inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a34b4057b238262cf738e9d353ddd2752" title="Universe::setData Accept new data from receiver.">Universe::setData</a> Accept new data from receiver. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a34b4057b238262cf738e9d353ddd2752">More...</a><br /></td></tr>
<tr class="separator:a34b4057b238262cf738e9d353ddd2752 inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c97ae94f8507b58ad4d14f38c17647f inherit pub_methods_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a7c97ae94f8507b58ad4d14f38c17647f">onData</a> (const DataHandler)</td></tr>
<tr class="memdesc:a7c97ae94f8507b58ad4d14f38c17647f inherit pub_methods_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a7c97ae94f8507b58ad4d14f38c17647f" title="Universe::onData.">Universe::onData</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a7c97ae94f8507b58ad4d14f38c17647f">More...</a><br /></td></tr>
<tr class="separator:a7c97ae94f8507b58ad4d14f38c17647f inherit pub_methods_class_d_m_x_1_1_universe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_a_c_n_1_1_d_m_p_1_1_device"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_a_c_n_1_1_d_m_p_1_1_device')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d3/d95/class_a_c_n_1_1_d_m_p_1_1_device.html">ACN::DMP::Device</a></td></tr>
<tr class="memitem:a53d20aea4c8963b0684cfa1b84aa4cd1 inherit pub_methods_class_a_c_n_1_1_d_m_p_1_1_device"><td class="memItemLeft" align="right" valign="top"><a id="a53d20aea4c8963b0684cfa1b84aa4cd1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d95/class_a_c_n_1_1_d_m_p_1_1_device.html#a53d20aea4c8963b0684cfa1b84aa4cd1">Device</a> ()</td></tr>
<tr class="memdesc:a53d20aea4c8963b0684cfa1b84aa4cd1 inherit pub_methods_class_a_c_n_1_1_d_m_p_1_1_device"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d3/d95/class_a_c_n_1_1_d_m_p_1_1_device.html#a53d20aea4c8963b0684cfa1b84aa4cd1" title="Device::Device.">Device::Device</a>. <br /></td></tr>
<tr class="separator:a53d20aea4c8963b0684cfa1b84aa4cd1 inherit pub_methods_class_a_c_n_1_1_d_m_p_1_1_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_d_m_x_1_1_universe"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_d_m_x_1_1_universe')"><img src="../../closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html">DMX::Universe</a></td></tr>
<tr class="memitem:ad0d2378e6927385b32b554db56bbfc05 inherit pro_attribs_class_d_m_x_1_1_universe"><td class="memItemLeft" align="right" valign="top"><a id="ad0d2378e6927385b32b554db56bbfc05"></a>
std::vector&lt; DataHandler &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#ad0d2378e6927385b32b554db56bbfc05">callbacks_</a></td></tr>
<tr class="memdesc:ad0d2378e6927385b32b554db56bbfc05 inherit pro_attribs_class_d_m_x_1_1_universe"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of calback functions <br /></td></tr>
<tr class="separator:ad0d2378e6927385b32b554db56bbfc05 inherit pro_attribs_class_d_m_x_1_1_universe"><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="../../d8/d1d/class_s_a_c_n_1_1_universe.html" title="The Universe class.">Universe</a> class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a921427bed93ca7fdce20849b87e94989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a921427bed93ca7fdce20849b87e94989">&#9670;&nbsp;</a></span>isSyncronized()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool SACN::Universe::isSyncronized </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a921427bed93ca7fdce20849b87e94989" title="Universe::isSyncronized.">Universe::isSyncronized</a>. </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#abbcfe663856f778b0d64189642034544">SACN::MergeProxyUniverse</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a921427bed93ca7fdce20849b87e94989_icgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a921427bed93ca7fdce20849b87e94989_icgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a921427bed93ca7fdce20849b87e94989_icgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a921427bed93ca7fdce20849b87e94989_icgraph">
<area shape="rect" title="Universe::isSyncronized." alt="" coords="449,5,660,32"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75" title="Universe::slot." alt="" coords="5,5,155,32"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#adb2e49602ef288ebe2504fcda961d212" title="Universe::synchronize." alt="" coords="203,31,401,57"/>
</map>
</div>
</div>
</div>
<a id="a84dc852cb904a72789352860c97c1731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84dc852cb904a72789352860c97c1731">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SACN::Universe::set </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../dd/d62/class_a_c_n_1_1_d_m_p_1_1_pdu.html">ACN::DMP::Pdu</a> &gt;&#160;</td>
<td class="paramname"><em>dmp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt;&#160;</td>
<td class="paramname"><em>source</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731" title="Universe::set.">Universe::set</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dmp</td><td></td></tr>
<tr><td class="paramname">source</td><td></td></tr>
</table>
</dd>
</dl>
<p>7.3 Address Type and Data Type Sources shall set the DMP Layer's Address Type and Data Type to 0xa1. Receivers shall discard the packet if the received value is not 0xa1.</p>
<p>7.4 First Property Address Sources shall set the DMP Layer's First Property Address to 0x0000. Receivers shall discard the packet if the received value is not 0x0000.</p>
<p>7.5 Address Increment Sources shall set the DMP Layer's Address Increment to 0x0001. Receivers shall discard the packet if the received value is not 0x0001.</p>
<p>7.6 Property Value Count The DMP Layer's Property Value Count is used to encode the number of DMX512-A [DMX] Slots (including the START Code slot).</p>
<p>7.7 Property Values (DMX512-A Data) The DMP Layer's Property values field is used to encode the DMX512-A [DMX] START Code and data.</p>
<p>6.2.4.1 If a receiver is presented with an E1.31 Data Packet containing a Synchronization Address of 0, it shall discard any data waiting to be processed and immediately act on that Data Packet.</p>
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#a28181c51f34e6401539279ca1edfac3a">SACN::MergeProxyUniverse</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_cgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_cgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_cgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_cgraph">
<area shape="rect" title="Universe::set." alt="" coords="5,81,152,108"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html#a778bff0bcc1bfe43ff8bcf2dccae3a5a" title="Universe::data." alt="" coords="235,5,380,32"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html#a34b4057b238262cf738e9d353ddd2752" title="Universe::setData Accept new data from receiver." alt="" coords="224,56,391,83"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a664f1264c2072e86722f4fef10b9afef" title="Universe::setSource." alt="" coords="200,107,415,133"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2" title="Universe::source." alt="" coords="463,132,629,159"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_icgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_icgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_icgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a84dc852cb904a72789352860c97c1731_icgraph">
<area shape="rect" title="Universe::set." alt="" coords="725,13,872,39"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#ae814bbf9d170f249584b45594b0d211a" title="Receiver::dataFrameHandler." alt="" coords="487,5,677,47"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a13e3e187b44cac129567200e24906ddb" title="Receiver::dataReceiver &#45; dispatcher of RLP DATA PDU." alt="" coords="233,13,439,39"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a34e4d8f21cd3f30b8a2ef166091cb6be" title="Receiver::Receiver." alt="" coords="5,13,185,39"/>
</map>
</div>
</div>
</div>
<a id="a664f1264c2072e86722f4fef10b9afef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a664f1264c2072e86722f4fef10b9afef">&#9670;&nbsp;</a></span>setProvenance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SACN::Universe::setProvenance </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt;&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Universe::setSource. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td></td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#aff78c13df1924669b1093eb5a0d69e2e">SACN::MergeProxyUniverse</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_cgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_cgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_cgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_cgraph">
<area shape="rect" title="Universe::setSource." alt="" coords="5,5,220,32"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2" title="Universe::source." alt="" coords="268,5,435,32"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_icgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_icgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_icgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a664f1264c2072e86722f4fef10b9afef_icgraph">
<area shape="rect" title="Universe::setSource." alt="" coords="920,13,1135,39"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731" title="Universe::set." alt="" coords="725,13,872,39"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#ae814bbf9d170f249584b45594b0d211a" title="Receiver::dataFrameHandler." alt="" coords="487,5,677,47"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a13e3e187b44cac129567200e24906ddb" title="Receiver::dataReceiver &#45; dispatcher of RLP DATA PDU." alt="" coords="233,13,439,39"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a34e4d8f21cd3f30b8a2ef166091cb6be" title="Receiver::Receiver." alt="" coords="5,13,185,39"/>
</map>
</div>
</div>
</div>
<a id="ad19b9643c99434558ad3c0ebc15e3e75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad19b9643c99434558ad3c0ebc15e3e75">&#9670;&nbsp;</a></span>slot()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t SACN::Universe::slot </td>
<td>(</td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>addr</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="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75" title="Universe::slot.">Universe::slot</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>6.2.6 E1.31 Data Packet: Options Force_Synchronization: Bit 5 This bit indicates whether to lock or revert to an unsynchronized state when synchronization is lost. When set to 0, components that had been operating in a synchronized state shall not update with any new packets until synchronization resumes. When set to 1, once synchronization has been lost, components that had been operating in a synchronized state need not wait for a new E1.31 Synchronization Packet in order to update to the next E1.31 Data Packet.</p>
<p>Reimplemented from <a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18">DMX::Universe</a>.</p>
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#a7b3322622bfd280914f225a8765fb43a">SACN::MergeProxyUniverse</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_ad19b9643c99434558ad3c0ebc15e3e75_cgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_ad19b9643c99434558ad3c0ebc15e3e75_cgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_ad19b9643c99434558ad3c0ebc15e3e75_cgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_ad19b9643c99434558ad3c0ebc15e3e75_cgraph">
<area shape="rect" title="Universe::slot." alt="" coords="5,83,155,110"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a921427bed93ca7fdce20849b87e94989" title="Universe::isSyncronized." alt="" coords="449,58,660,84"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html#a3d0c6c197a42c65d2db1ca374b58f811" title="Universe::rxRate Rate (in Hz) at which the universe is being recv&#39;d." alt="" coords="223,32,381,59"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18" title="Universe::slot." alt="" coords="231,83,373,110"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2" title="Universe::source." alt="" coords="219,134,385,160"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#adb2e49602ef288ebe2504fcda961d212" title="Universe::synchronize." alt="" coords="203,184,401,211"/>
<area shape="rect" href="../../d0/de4/class_d_m_x_1_1_universe.html#a34b4057b238262cf738e9d353ddd2752" title="Universe::setData Accept new data from receiver." alt="" coords="471,184,638,211"/>
</map>
</div>
</div>
</div>
<a id="a77331a84244061551e7da1c9741905e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77331a84244061551e7da1c9741905e2">&#9670;&nbsp;</a></span>source()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d8/d01/class_s_a_c_n_1_1_provenance.html">Provenance</a> &gt; SACN::Universe::source </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a77331a84244061551e7da1c9741905e2" title="Universe::source.">Universe::source</a>. </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#a0d2d7849fc0df228e6caa598146c2d3f">SACN::MergeProxyUniverse</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d1d/class_s_a_c_n_1_1_universe_a77331a84244061551e7da1c9741905e2_icgraph.png" border="0" usemap="#ad8/d1d/class_s_a_c_n_1_1_universe_a77331a84244061551e7da1c9741905e2_icgraph" alt=""/></div>
<map name="ad8/d1d/class_s_a_c_n_1_1_universe_a77331a84244061551e7da1c9741905e2_icgraph" id="ad8/d1d/class_s_a_c_n_1_1_universe_a77331a84244061551e7da1c9741905e2_icgraph">
<area shape="rect" title="Universe::source." alt="" coords="1183,97,1349,123"/>
<area shape="rect" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#a525837fb67ca9cd36681c454983e5a46" title="MergeProxyUniverse::addSourceUniverse." alt="" coords="932,5,1123,47"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731" title="Universe::set." alt="" coords="725,97,872,123"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a664f1264c2072e86722f4fef10b9afef" title="Universe::setSource." alt="" coords="920,122,1135,149"/>
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75" title="Universe::slot." alt="" coords="953,173,1102,199"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#ae814bbf9d170f249584b45594b0d211a" title="Receiver::dataFrameHandler." alt="" coords="487,89,677,131"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a13e3e187b44cac129567200e24906ddb" title="Receiver::dataReceiver &#45; dispatcher of RLP DATA PDU." alt="" coords="233,97,439,123"/>
<area shape="rect" href="../../da/dde/class_s_a_c_n_1_1_receiver.html#a34e4d8f21cd3f30b8a2ef166091cb6be" title="Receiver::Receiver." alt="" coords="5,97,185,123"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sacn/universe.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sacn/universe.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