Deploying to gh-pages from @ 87d8c5f 🚀

DCCEXProtocol_8h_source.html

@@ -403,7 +403,7 @@
 <div class="line"><a name="l00497"></a><span class="lineno">  497</span>&#160;};</div>
 <div class="line"><a name="l00498"></a><span class="lineno">  498</span>&#160; </div>
 <div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DCCEXPROTOCOL_H</span></div>
-<div class="ttc" id="aclassConsist_html"><div class="ttname"><a href="classConsist.html">Consist</a></div><div class="ttdoc">Class to create a software consist of one or more ConsistLoco objects.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.h:176</div></div>
+<div class="ttc" id="aclassConsist_html"><div class="ttname"><a href="classConsist.html">Consist</a></div><div class="ttdoc">Class to create a software consist of one or more ConsistLoco objects.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.h:181</div></div>
 <div class="ttc" id="aclassDCCEXProtocolDelegate_html"><div class="ttname"><a href="classDCCEXProtocolDelegate.html">DCCEXProtocolDelegate</a></div><div class="ttdoc">Delegate responses and broadcast events to the client software to enable custom event handlers.</div><div class="ttdef"><b>Definition:</b> DCCEXProtocol.h:108</div></div>
 <div class="ttc" id="aclassDCCEXProtocolDelegate_html_a07057e8b7e6746b92e0378a5790b8970"><div class="ttname"><a href="classDCCEXProtocolDelegate.html#a07057e8b7e6746b92e0378a5790b8970">DCCEXProtocolDelegate::receivedServerVersion</a></div><div class="ttdeci">virtual void receivedServerVersion(int major, int minor, int patch)</div><div class="ttdoc">Notify when the server version has been received.</div><div class="ttdef"><b>Definition:</b> DCCEXProtocol.h:114</div></div>
 <div class="ttc" id="aclassDCCEXProtocolDelegate_html_a2e8263c6031cb75b5fe70801e708e503"><div class="ttname"><a href="classDCCEXProtocolDelegate.html#a2e8263c6031cb75b5fe70801e708e503">DCCEXProtocolDelegate::receivedRosterList</a></div><div class="ttdeci">virtual void receivedRosterList()</div><div class="ttdoc">Notify when the roster list is received.</div><div class="ttdef"><b>Definition:</b> DCCEXProtocol.h:117</div></div>

bugs-requests.html

@@ -287,6 +287,7 @@
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12isFunctionOnEi"><code class="docutils literal notranslate"><span class="pre">Loco::isFunctionOn()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17setFunctionStatesEi"><code class="docutils literal notranslate"><span class="pre">Loco::setFunctionStates()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17getFunctionStatesEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionStates()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco15getFunctionNameEi"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionName()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco7getNextEv"><code class="docutils literal notranslate"><span class="pre">Loco::getNext()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco8getFirstEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFirst()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12getByAddressEi"><code class="docutils literal notranslate"><span class="pre">Loco::getByAddress()</span></code></a></li>

classConsist.html

@@ -219,6 +219,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1ae98b1b9d353a5e1b1d58a7
 </div><div class="memdoc">
 
 <p>Get the loco in the consist with the specified address. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">address</td><td>DCC address of loco to retrieve </td></tr>
+  </table>
+  </dd>
+</dl>
 <dl class="section return"><dt>Returns</dt><dd>Pointer to the first <a class="el" href="classConsistLoco.html" title="Class to add an additional attribute to a Loco object to specify the direction it is facing in a cons...">ConsistLoco</a> object </dd></dl>
 
 </div>

classLoco-members.html

@@ -74,18 +74,19 @@
   <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a5472391c843ccb3e524f77cbd037d6fb">getByAddress</a>(int address)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr><td class="entry"><a class="el" href="classLoco.html#a70f677c06d15cc93dfa455a858dacb6e">getDirection</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classLoco.html#ad1ef3ad074cd46466d4e30942b76052e">getFirst</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">getFunctionStates</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#aedcf33904cdcb5d975c5e5bc7d909b50">getName</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#ad37fb945d6079242e8d725006db02d0e">getNext</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a64cb0c07bf90a8db61cc68ae8117c74d">getSource</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#ac93ba46b0dd84257eba7860f8084a398">getSpeed</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a14fbd2273f42f679f3883c30cd13c3e6">isFunctionOn</a>(int function)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#a23dc670b766d84a721a7a93c52817afd">Loco</a>(int address, LocoSource source)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a1872d4fd2345a947754cf7c1c6ef9b64">setDirection</a>(Direction direction)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#a45fff59dfefe29683ae76c42fcdc3573">setFunctionStates</a>(int functionStates)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#aa8f2bf9fa3acd8954d4ab2dca94ae8d7">setName</a>(char *name)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classLoco.html#a318a6ff7b4885b75e7ea197489ad3b89">setSpeed</a>(int speed)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a84c9f65b1067a43552ea83ec9f1f8604">setupFunctions</a>(char *functionNames)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#a5f8e1f819d545465ab4b84bde471b3f4">getFunctionName</a>(int function)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">getFunctionStates</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#aedcf33904cdcb5d975c5e5bc7d909b50">getName</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#ad37fb945d6079242e8d725006db02d0e">getNext</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#a64cb0c07bf90a8db61cc68ae8117c74d">getSource</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#ac93ba46b0dd84257eba7860f8084a398">getSpeed</a>()</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#a14fbd2273f42f679f3883c30cd13c3e6">isFunctionOn</a>(int function)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a23dc670b766d84a721a7a93c52817afd">Loco</a>(int address, LocoSource source)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#a1872d4fd2345a947754cf7c1c6ef9b64">setDirection</a>(Direction direction)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a45fff59dfefe29683ae76c42fcdc3573">setFunctionStates</a>(int functionStates)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#aa8f2bf9fa3acd8954d4ab2dca94ae8d7">setName</a>(char *name)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classLoco.html#a318a6ff7b4885b75e7ea197489ad3b89">setSpeed</a>(int speed)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classLoco.html#a84c9f65b1067a43552ea83ec9f1f8604">setupFunctions</a>(char *functionNames)</td><td class="entry"><a class="el" href="classLoco.html">Loco</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

classLoco.html

@@ -118,6 +118,9 @@
 <tr class="memitem:a69671b589ef874fc3a4476548c3837fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">getFunctionStates</a> ()</td></tr>
 <tr class="memdesc:a69671b589ef874fc3a4476548c3837fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get function states.  <a href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">More...</a><br /></td></tr>
 <tr class="separator:a69671b589ef874fc3a4476548c3837fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5f8e1f819d545465ab4b84bde471b3f4"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLoco.html#a5f8e1f819d545465ab4b84bde471b3f4">getFunctionName</a> (int function)</td></tr>
+<tr class="memdesc:a5f8e1f819d545465ab4b84bde471b3f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name/label for a function.  <a href="classLoco.html#a5f8e1f819d545465ab4b84bde471b3f4">More...</a><br /></td></tr>
+<tr class="separator:a5f8e1f819d545465ab4b84bde471b3f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad37fb945d6079242e8d725006db02d0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classLoco.html">Loco</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLoco.html#ad37fb945d6079242e8d725006db02d0e">getNext</a> ()</td></tr>
 <tr class="memdesc:ad37fb945d6079242e8d725006db02d0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get next <a class="el" href="classLoco.html" title="Class for a Loco object representing a DCC addressed locomotive.">Loco</a> object.  <a href="classLoco.html#ad37fb945d6079242e8d725006db02d0e">More...</a><br /></td></tr>
 <tr class="separator:ad37fb945d6079242e8d725006db02d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -279,6 +282,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad1ef3ad074cd46466d4e3094
 <p>Get first <a class="el" href="classLoco.html" title="Class for a Loco object representing a DCC addressed locomotive.">Loco</a> object. </p>
 <dl class="section return"><dt>Returns</dt><dd>Pointer to the first <a class="el" href="classLoco.html" title="Class for a Loco object representing a DCC addressed locomotive.">Loco</a> object </dd></dl>
 
+</div>
+</div>
+<a id="a5f8e1f819d545465ab4b84bde471b3f4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5f8e1f819d545465ab4b84bde471b3f4">&#9670;&nbsp;</a></span>getFunctionName()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char * Loco::getFunctionName </td>
+          <td>(</td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>function</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Get the name/label for a function. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">function</td><td>Number of the function to return the name/label of </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>char* representing the function name/label </dd></dl>
+
 </div>
 </div>
 <a id="a69671b589ef874fc3a4476548c3837fa"></a>

contribute.html

@@ -288,6 +288,7 @@
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12isFunctionOnEi"><code class="docutils literal notranslate"><span class="pre">Loco::isFunctionOn()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17setFunctionStatesEi"><code class="docutils literal notranslate"><span class="pre">Loco::setFunctionStates()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17getFunctionStatesEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionStates()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco15getFunctionNameEi"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionName()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco7getNextEv"><code class="docutils literal notranslate"><span class="pre">Loco::getNext()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco8getFirstEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFirst()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12getByAddressEi"><code class="docutils literal notranslate"><span class="pre">Loco::getByAddress()</span></code></a></li>

examples.html

@@ -288,6 +288,7 @@
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12isFunctionOnEi"><code class="docutils literal notranslate"><span class="pre">Loco::isFunctionOn()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17setFunctionStatesEi"><code class="docutils literal notranslate"><span class="pre">Loco::setFunctionStates()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17getFunctionStatesEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionStates()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco15getFunctionNameEi"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionName()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco7getNextEv"><code class="docutils literal notranslate"><span class="pre">Loco::getNext()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco8getFirstEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFirst()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12getByAddressEi"><code class="docutils literal notranslate"><span class="pre">Loco::getByAddress()</span></code></a></li>

functions.html

@@ -182,6 +182,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>getFirstIndex()
 : <a class="el" href="classTurntable.html#ab00bb525076ebca9cf95f4bb04900ccc">Turntable</a>
 </li>
+<li>getFunctionName()
+: <a class="el" href="classLoco.html#a5f8e1f819d545465ab4b84bde471b3f4">Loco</a>
+</li>
 <li>getFunctionStates()
 : <a class="el" href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">Loco</a>
 </li>

functions_func.html

@@ -182,6 +182,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>getFirstIndex()
 : <a class="el" href="classTurntable.html#ab00bb525076ebca9cf95f4bb04900ccc">Turntable</a>
 </li>
+<li>getFunctionName()
+: <a class="el" href="classLoco.html#a5f8e1f819d545465ab4b84bde471b3f4">Loco</a>
+</li>
 <li>getFunctionStates()
 : <a class="el" href="classLoco.html#a69671b589ef874fc3a4476548c3837fa">Loco</a>
 </li>

genindex.html

@@ -284,6 +284,7 @@
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12isFunctionOnEi"><code class="docutils literal notranslate"><span class="pre">Loco::isFunctionOn()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17setFunctionStatesEi"><code class="docutils literal notranslate"><span class="pre">Loco::setFunctionStates()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco17getFunctionStatesEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionStates()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco15getFunctionNameEi"><code class="docutils literal notranslate"><span class="pre">Loco::getFunctionName()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco7getNextEv"><code class="docutils literal notranslate"><span class="pre">Loco::getNext()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco8getFirstEv"><code class="docutils literal notranslate"><span class="pre">Loco::getFirst()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N4Loco12getByAddressEi"><code class="docutils literal notranslate"><span class="pre">Loco::getByAddress()</span></code></a></li>
@@ -925,6 +926,8 @@ <h2 id="L">L</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="library.html#_CPPv4N4Loco15getFunctionNameEi">Loco::getFunctionName (C++ function)</a>
+</li>
       <li><a href="library.html#_CPPv4N4Loco17getFunctionStatesEv">Loco::getFunctionStates (C++ function)</a>
 </li>
       <li><a href="library.html#_CPPv4N4Loco7getNameEv">Loco::getName (C++ function)</a>