Deploying to gh-pages from @ ff432e4 🚀

DCC-EX · Dec 16, 2023 · 9cfc2cc · 9cfc2cc
1 parent cc2cea6
commit 9cfc2cc
Show file tree

Hide file tree

Showing 22 changed files with 96 additions and 42 deletions.
diff --git a/DCCEXLoco_8h_source.html b/DCCEXLoco_8h_source.html
@@ -224,16 +224,18 @@
 <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160; </div>
 <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;  <a class="code" href="classConsistLoco.html">ConsistLoco</a>* <a class="code" href="classConsist.html#a401e486a678d211af16d1d5adc495e5f">getFirst</a>();</div>
 <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160; </div>
-<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="keyword">private</span>:</div>
-<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;  <span class="keywordtype">char</span>* _name;</div>
-<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;  <span class="keywordtype">int</span> _locoCount;</div>
-<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;  <a class="code" href="classConsistLoco.html">ConsistLoco</a>* _first;</div>
-<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160; </div>
-<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;  <span class="keywordtype">void</span> _addLocoToConsist(<a class="code" href="classConsistLoco.html">ConsistLoco</a>* consistLoco);</div>
-<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160; </div>
-<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;};</div>
+<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;  <a class="code" href="classConsistLoco.html">ConsistLoco</a>* <a class="code" href="classConsist.html#a1ae98b1b9d353a5e1b1d58a729bc1e11">getByAddress</a>(<span class="keywordtype">int</span> address);</div>
+<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160; </div>
+<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="keyword">private</span>:</div>
+<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;  <span class="keywordtype">char</span>* _name;</div>
+<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;  <span class="keywordtype">int</span> _locoCount;</div>
+<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;  <a class="code" href="classConsistLoco.html">ConsistLoco</a>* _first;</div>
 <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160; </div>
-<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;  <span class="keywordtype">void</span> _addLocoToConsist(<a class="code" href="classConsistLoco.html">ConsistLoco</a>* consistLoco);</div>
+<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160; </div>
+<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;};</div>
+<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160; </div>
+<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aclassConsistLoco_html"><div class="ttname"><a href="classConsistLoco.html">ConsistLoco</a></div><div class="ttdoc">Class to add an additional attribute to a Loco object to specify the direction it is facing in a cons...</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.h:139</div></div>
 <div class="ttc" id="aclassConsistLoco_html_a16e1435b06a8565c9f216e48e419198d"><div class="ttname"><a href="classConsistLoco.html#a16e1435b06a8565c9f216e48e419198d">ConsistLoco::setFacing</a></div><div class="ttdeci">void setFacing(Facing facing)</div><div class="ttdoc">Set which way the loco is facing in the consist (FacingForward, FacingReversed)</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:176</div></div>
 <div class="ttc" id="aclassConsistLoco_html_a2b22ec62fc2897ed02280c25e8dbcc35"><div class="ttname"><a href="classConsistLoco.html#a2b22ec62fc2897ed02280c25e8dbcc35">ConsistLoco::getLoco</a></div><div class="ttdeci">Loco * getLoco()</div><div class="ttdoc">Get the associated Loco object for this consist entry.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:172</div></div>
@@ -243,17 +245,18 @@
 <div class="ttc" id="aclassConsistLoco_html_ac4cdc35b52d4bb678e83e8ea75a80976"><div class="ttname"><a href="classConsistLoco.html#ac4cdc35b52d4bb678e83e8ea75a80976">ConsistLoco::getFacing</a></div><div class="ttdeci">Facing getFacing()</div><div class="ttdoc">Get which way the loco is facing in the consist (FacingForward, FacingReversed)</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:180</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:176</div></div>
 <div class="ttc" id="aclassConsist_html_a174e98c8d1fb36955d9e1d9f4f3f1afa"><div class="ttname"><a href="classConsist.html#a174e98c8d1fb36955d9e1d9f4f3f1afa">Consist::setName</a></div><div class="ttdeci">void setName(char *name)</div><div class="ttdoc">Set consist name.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:201</div></div>
+<div class="ttc" id="aclassConsist_html_a1ae98b1b9d353a5e1b1d58a729bc1e11"><div class="ttname"><a href="classConsist.html#a1ae98b1b9d353a5e1b1d58a729bc1e11">Consist::getByAddress</a></div><div class="ttdeci">ConsistLoco * getByAddress(int address)</div><div class="ttdoc">Get the loco in the consist with the specified address.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:319</div></div>
 <div class="ttc" id="aclassConsist_html_a1cd3449bf559e02a02dd4ea62e9b4bcb"><div class="ttname"><a href="classConsist.html#a1cd3449bf559e02a02dd4ea62e9b4bcb">Consist::addLoco</a></div><div class="ttdeci">void addLoco(Loco *loco, Facing facing)</div><div class="ttdoc">Add a loco to the consist using a Loco object.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:209</div></div>
 <div class="ttc" id="aclassConsist_html_a3fa1c5fad9ecc08d2347cb679a897cc6"><div class="ttname"><a href="classConsist.html#a3fa1c5fad9ecc08d2347cb679a897cc6">Consist::getName</a></div><div class="ttdeci">char * getName()</div><div class="ttdoc">Get consist name.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:205</div></div>
-<div class="ttc" id="aclassConsist_html_a401e486a678d211af16d1d5adc495e5f"><div class="ttname"><a href="classConsist.html#a401e486a678d211af16d1d5adc495e5f">Consist::getFirst</a></div><div class="ttdeci">ConsistLoco * getFirst()</div><div class="ttdoc">Get the first loco in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:312</div></div>
-<div class="ttc" id="aclassConsist_html_a409ebe6bd16f34913338997a768a2155"><div class="ttname"><a href="classConsist.html#a409ebe6bd16f34913338997a768a2155">Consist::getDirection</a></div><div class="ttdeci">Direction getDirection()</div><div class="ttdoc">Get consist direction - obtained from first linked loco.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:306</div></div>
-<div class="ttc" id="aclassConsist_html_a50058cf23541647223de81c4112ac9a3"><div class="ttname"><a href="classConsist.html#a50058cf23541647223de81c4112ac9a3">Consist::setLocoFacing</a></div><div class="ttdeci">void setLocoFacing(Loco *loco, Facing facing)</div><div class="ttdoc">Update the direction of a loco in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:270</div></div>
+<div class="ttc" id="aclassConsist_html_a401e486a678d211af16d1d5adc495e5f"><div class="ttname"><a href="classConsist.html#a401e486a678d211af16d1d5adc495e5f">Consist::getFirst</a></div><div class="ttdeci">ConsistLoco * getFirst()</div><div class="ttdoc">Get the first loco in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:315</div></div>
+<div class="ttc" id="aclassConsist_html_a409ebe6bd16f34913338997a768a2155"><div class="ttname"><a href="classConsist.html#a409ebe6bd16f34913338997a768a2155">Consist::getDirection</a></div><div class="ttdeci">Direction getDirection()</div><div class="ttdoc">Get consist direction - obtained from first linked loco.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:309</div></div>
+<div class="ttc" id="aclassConsist_html_a50058cf23541647223de81c4112ac9a3"><div class="ttname"><a href="classConsist.html#a50058cf23541647223de81c4112ac9a3">Consist::setLocoFacing</a></div><div class="ttdeci">void setLocoFacing(Loco *loco, Facing facing)</div><div class="ttdoc">Update the direction of a loco in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:273</div></div>
 <div class="ttc" id="aclassConsist_html_a5a0248ba38bc54b68516a5718ea0acc9"><div class="ttname"><a href="classConsist.html#a5a0248ba38bc54b68516a5718ea0acc9">Consist::removeLoco</a></div><div class="ttdeci">void removeLoco(Loco *loco)</div><div class="ttdoc">Remove a loco from the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:232</div></div>
-<div class="ttc" id="aclassConsist_html_a856cecc8dea7e1431dd0ea550d52c0c7"><div class="ttname"><a href="classConsist.html#a856cecc8dea7e1431dd0ea550d52c0c7">Consist::removeAllLocos</a></div><div class="ttdeci">void removeAllLocos()</div><div class="ttdoc">Remove all locos from a consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:256</div></div>
-<div class="ttc" id="aclassConsist_html_aa29df76203ba1f6bc48963198365295f"><div class="ttname"><a href="classConsist.html#aa29df76203ba1f6bc48963198365295f">Consist::getSpeed</a></div><div class="ttdeci">int getSpeed()</div><div class="ttdoc">Get consist speed - obtained from first linked loco.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:300</div></div>
-<div class="ttc" id="aclassConsist_html_aac343f324170543a427cc0d323d1b154"><div class="ttname"><a href="classConsist.html#aac343f324170543a427cc0d323d1b154">Consist::getLocoCount</a></div><div class="ttdeci">int getLocoCount()</div><div class="ttdoc">Get the count of locos in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:278</div></div>
+<div class="ttc" id="aclassConsist_html_a856cecc8dea7e1431dd0ea550d52c0c7"><div class="ttname"><a href="classConsist.html#a856cecc8dea7e1431dd0ea550d52c0c7">Consist::removeAllLocos</a></div><div class="ttdeci">void removeAllLocos()</div><div class="ttdoc">Remove all locos from a consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:258</div></div>
+<div class="ttc" id="aclassConsist_html_aa29df76203ba1f6bc48963198365295f"><div class="ttname"><a href="classConsist.html#aa29df76203ba1f6bc48963198365295f">Consist::getSpeed</a></div><div class="ttdeci">int getSpeed()</div><div class="ttdoc">Get consist speed - obtained from first linked loco.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:303</div></div>
+<div class="ttc" id="aclassConsist_html_aac343f324170543a427cc0d323d1b154"><div class="ttname"><a href="classConsist.html#aac343f324170543a427cc0d323d1b154">Consist::getLocoCount</a></div><div class="ttdeci">int getLocoCount()</div><div class="ttdoc">Get the count of locos in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:281</div></div>
 <div class="ttc" id="aclassConsist_html_ae3f452cf16c50d9a75a24c2d2a16c719"><div class="ttname"><a href="classConsist.html#ae3f452cf16c50d9a75a24c2d2a16c719">Consist::Consist</a></div><div class="ttdeci">Consist()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:195</div></div>
-<div class="ttc" id="aclassConsist_html_af4a2875be6a281ff70a259110406a313"><div class="ttname"><a href="classConsist.html#af4a2875be6a281ff70a259110406a313">Consist::inConsist</a></div><div class="ttdeci">bool inConsist(Loco *loco)</div><div class="ttdoc">Check if the provided loco is in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:282</div></div>
+<div class="ttc" id="aclassConsist_html_af4a2875be6a281ff70a259110406a313"><div class="ttname"><a href="classConsist.html#af4a2875be6a281ff70a259110406a313">Consist::inConsist</a></div><div class="ttdeci">bool inConsist(Loco *loco)</div><div class="ttdoc">Check if the provided loco is in the consist.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:285</div></div>
 <div class="ttc" id="aclassLoco_html"><div class="ttname"><a href="classLoco.html">Loco</a></div><div class="ttdoc">Class for a Loco object representing a DCC addressed locomotive.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.h:54</div></div>
 <div class="ttc" id="aclassLoco_html_a14fbd2273f42f679f3883c30cd13c3e6"><div class="ttname"><a href="classLoco.html#a14fbd2273f42f679f3883c30cd13c3e6">Loco::isFunctionOn</a></div><div class="ttdeci">bool isFunctionOn(int function)</div><div class="ttdoc">Test if function is on.</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:134</div></div>
 <div class="ttc" id="aclassLoco_html_a1872d4fd2345a947754cf7c1c6ef9b64"><div class="ttname"><a href="classLoco.html#a1872d4fd2345a947754cf7c1c6ef9b64">Loco::setDirection</a></div><div class="ttdeci">void setDirection(Direction direction)</div><div class="ttdoc">Set loco direction (enums Forward, Reverse)</div><div class="ttdef"><b>Definition:</b> DCCEXLoco.cpp:77</div></div>