449 lines
27 KiB
HTML
449 lines
27 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: DMX::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
|
|
 <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&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&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>DMX</b></li><li class="navelem"><a class="el" href="../../d0/de4/class_d_m_x_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> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="../../dd/d74/class_d_m_x_1_1_universe-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DMX::Universe Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html" title="The Universe class.">Universe</a> class.
|
|
<a href="../../d0/de4/class_d_m_x_1_1_universe.html#details">More...</a></p>
|
|
|
|
<p><code>#include <universe.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for DMX::Universe:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="../../d7/de5/class_d_m_x_1_1_universe__inherit__graph.png" border="0" usemap="#a_d_m_x_1_1_universe_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="a_d_m_x_1_1_universe_inherit__map" id="a_d_m_x_1_1_universe_inherit__map">
|
|
<area shape="rect" title="The Universe class." alt="" coords="45,5,157,32"/>
|
|
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html" title="The Universe class." alt="" coords="41,80,161,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="5,155,196,181"/>
|
|
</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:a86b5d8dd6295fbb936b042df4113a9da"><td class="memItemLeft" align="right" valign="top"> </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f935a754fd92eb9e690a55ffd7da3c7"><td class="memItemLeft" align="right" valign="top"><a id="a8f935a754fd92eb9e690a55ffd7da3c7"></a>
|
|
virtual </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a778bff0bcc1bfe43ff8bcf2dccae3a5a"><td class="memItemLeft" align="right" valign="top">virtual const DimmerData * </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a3aa399e1907fd0663f28bd3233de18"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18">slot</a> (const uint16_t)</td></tr>
|
|
<tr class="memdesc:a9a3aa399e1907fd0663f28bd3233de18"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18" title="Universe::slot.">Universe::slot</a>. <a href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a3aa399e1907fd0663f28bd3233de18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d0c6c197a42c65d2db1ca374b58f811"><td class="memItemLeft" align="right" valign="top">virtual double </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"><td class="mdescLeft"> </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'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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53d1648233d98fc1511dfdb6a77b9c75"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfc92c3f0a743fd6658d968d68710098"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34b4057b238262cf738e9d353ddd2752"><td class="memItemLeft" align="right" valign="top">void </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< uint8_t >)</td></tr>
|
|
<tr class="memdesc:a34b4057b238262cf738e9d353ddd2752"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c97ae94f8507b58ad4d14f38c17647f"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ad0d2378e6927385b32b554db56bbfc05"><td class="memItemLeft" align="right" valign="top"><a id="ad0d2378e6927385b32b554db56bbfc05"></a>
|
|
std::vector< DataHandler > </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"><td class="mdescLeft"> </td><td class="mdescRight">list of calback functions <br /></td></tr>
|
|
<tr class="separator:ad0d2378e6927385b32b554db56bbfc05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html" title="The Universe class.">Universe</a> class. </p>
|
|
<p>ANSI E1.11 describes may things about moving data over serial EIA-485-A links. This class encapselates that data, regardless of how it was transmitted. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a86b5d8dd6295fbb936b042df4113a9da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86b5d8dd6295fbb936b042df4113a9da">◆ </a></span>Universe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DMX::Universe::Universe </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>timeout_period</em> = <code>E111_DATA_LOSS_TIMEOUT</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a86b5d8dd6295fbb936b042df4113a9da" title="Universe::Universe.">Universe::Universe</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout_period</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a778bff0bcc1bfe43ff8bcf2dccae3a5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a778bff0bcc1bfe43ff8bcf2dccae3a5a">◆ </a></span>data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const DimmerData * DMX::Universe::data </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="../../d0/de4/class_d_m_x_1_1_universe.html#a778bff0bcc1bfe43ff8bcf2dccae3a5a" title="Universe::data.">Universe::data</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#aabac53a77d7c5d30018f35a3a1638279">SACN::MergeProxyUniverse</a>.</p>
|
|
<div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="../../d0/de4/class_d_m_x_1_1_universe_a778bff0bcc1bfe43ff8bcf2dccae3a5a_icgraph.png" border="0" usemap="#ad0/de4/class_d_m_x_1_1_universe_a778bff0bcc1bfe43ff8bcf2dccae3a5a_icgraph" alt=""/></div>
|
|
<map name="ad0/de4/class_d_m_x_1_1_universe_a778bff0bcc1bfe43ff8bcf2dccae3a5a_icgraph" id="ad0/de4/class_d_m_x_1_1_universe_a778bff0bcc1bfe43ff8bcf2dccae3a5a_icgraph">
|
|
<area shape="rect" title="Universe::data." alt="" coords="920,13,1065,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 - 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="a7c97ae94f8507b58ad4d14f38c17647f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c97ae94f8507b58ad4d14f38c17647f">◆ </a></span>onData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DMX::Universe::onData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const DataHandler </td>
|
|
<td class="paramname"><em>callback</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a7c97ae94f8507b58ad4d14f38c17647f" title="Universe::onData.">Universe::onData</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d0c6c197a42c65d2db1ca374b58f811"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d0c6c197a42c65d2db1ca374b58f811">◆ </a></span>rxRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double DMX::Universe::rxRate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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="../../d0/de4/class_d_m_x_1_1_universe.html#a3d0c6c197a42c65d2db1ca374b58f811" title="Universe::rxRate Rate (in Hz) at which the universe is being recv'd.">Universe::rxRate</a> Rate (in Hz) at which the universe is being recv'd. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Hz</dd></dl>
|
|
<p>Calculated as the rolling mean of (the number of frames in the last rx_timeout_peroid ms) / rx_timeout_period seconds. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../d4/db4/class_s_a_c_n_1_1_merge_proxy_universe.html#a00c71b34c8e56a041f12bc22649e8150">SACN::MergeProxyUniverse</a>.</p>
|
|
<div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="../../d0/de4/class_d_m_x_1_1_universe_a3d0c6c197a42c65d2db1ca374b58f811_icgraph.png" border="0" usemap="#ad0/de4/class_d_m_x_1_1_universe_a3d0c6c197a42c65d2db1ca374b58f811_icgraph" alt=""/></div>
|
|
<map name="ad0/de4/class_d_m_x_1_1_universe_a3d0c6c197a42c65d2db1ca374b58f811_icgraph" id="ad0/de4/class_d_m_x_1_1_universe_a3d0c6c197a42c65d2db1ca374b58f811_icgraph">
|
|
<area shape="rect" title="Universe::rxRate Rate (in Hz) at which the universe is being recv'd." alt="" coords="203,5,361,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"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a34b4057b238262cf738e9d353ddd2752"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34b4057b238262cf738e9d353ddd2752">◆ </a></span>setData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DMX::Universe::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< uint8_t > </td>
|
|
<td class="paramname"><em>vect</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vect</td><td>varaibly sized data, beginning with a start code.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The only setData method used to establish rx rate. </p>
|
|
<div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="../../d0/de4/class_d_m_x_1_1_universe_a34b4057b238262cf738e9d353ddd2752_icgraph.png" border="0" usemap="#ad0/de4/class_d_m_x_1_1_universe_a34b4057b238262cf738e9d353ddd2752_icgraph" alt=""/></div>
|
|
<map name="ad0/de4/class_d_m_x_1_1_universe_a34b4057b238262cf738e9d353ddd2752_icgraph" id="ad0/de4/class_d_m_x_1_1_universe_a34b4057b238262cf738e9d353ddd2752_icgraph">
|
|
<area shape="rect" title="Universe::setData Accept new data from receiver." alt="" coords="972,42,1139,69"/>
|
|
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#a84dc852cb904a72789352860c97c1731" title="Universe::set." alt="" coords="751,15,898,42"/>
|
|
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#adb2e49602ef288ebe2504fcda961d212" title="Universe::synchronize." alt="" coords="725,67,924,94"/>
|
|
<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 - 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"/>
|
|
<area shape="rect" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75" title="Universe::slot." alt="" coords="507,71,657,98"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfc92c3f0a743fd6658d968d68710098"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfc92c3f0a743fd6658d968d68710098">◆ </a></span>setValue() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DMX::Universe::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>footprint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>profile</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75" title="Universe::setValue.">Universe::setValue</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">start</td><td></td></tr>
|
|
<tr><td class="paramname">footprint</td><td></td></tr>
|
|
<tr><td class="paramname">profile</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53d1648233d98fc1511dfdb6a77b9c75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53d1648233d98fc1511dfdb6a77b9c75">◆ </a></span>setValue() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DMX::Universe::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a53d1648233d98fc1511dfdb6a77b9c75" title="Universe::setValue.">Universe::setValue</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">address</td><td></td></tr>
|
|
<tr><td class="paramname">value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a3aa399e1907fd0663f28bd3233de18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a3aa399e1907fd0663f28bd3233de18">◆ </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 DMX::Universe::slot </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>address</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><a class="el" href="../../d0/de4/class_d_m_x_1_1_universe.html#a9a3aa399e1907fd0663f28bd3233de18" title="Universe::slot.">Universe::slot</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">address</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../d8/d1d/class_s_a_c_n_1_1_universe.html#ad19b9643c99434558ad3c0ebc15e3e75">SACN::Universe</a>, and <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 caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="../../d0/de4/class_d_m_x_1_1_universe_a9a3aa399e1907fd0663f28bd3233de18_icgraph.png" border="0" usemap="#ad0/de4/class_d_m_x_1_1_universe_a9a3aa399e1907fd0663f28bd3233de18_icgraph" alt=""/></div>
|
|
<map name="ad0/de4/class_d_m_x_1_1_universe_a9a3aa399e1907fd0663f28bd3233de18_icgraph" id="ad0/de4/class_d_m_x_1_1_universe_a9a3aa399e1907fd0663f28bd3233de18_icgraph">
|
|
<area shape="rect" title="Universe::slot." alt="" coords="203,5,344,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"/>
|
|
</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/dmx/universe.h</li>
|
|
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/dmx/universe.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|