update doxygen with last cahnges

This commit is contained in:
deeaitch committed 2026-10-05 18:50:00 -04:00
1 parent 1163277b17
commit 6cd99768ae
286 files changed
+10735 -3471

No files matched your search

+55 -48
View File
@@ -1,9 +1,9 @@
<!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">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DBC Framework: DecodeFrame Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -34,10 +34,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -77,9 +77,16 @@ $(document).ready(function(){initNavTree('structDecodeFrame.html',''); initResiz
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
@@ -97,32 +104,32 @@ $(document).ready(function(){initNavTree('structDecodeFrame.html',''); initResiz
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#aa0a7f8fd5bfde2148dfd0d838328f579">name</a></td></tr>
<tr class="memitem:aa0a7f8fd5bfde2148dfd0d838328f579" id="r_aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#aa0a7f8fd5bfde2148dfd0d838328f579">name</a></td></tr>
<tr class="separator:aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e10215388db7df8b541b9d9909edcf"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">canId</a></td></tr>
<tr class="memitem:a52e10215388db7df8b541b9d9909edcf" id="r_a52e10215388db7df8b541b9d9909edcf"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">canId</a></td></tr>
<tr class="separator:a52e10215388db7df8b541b9d9909edcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">isExtended</a></td></tr>
<tr class="memitem:a3ee2348d781f8f15aaf87e8dcf57ec41" id="r_a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">isExtended</a></td></tr>
<tr class="separator:a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51111ac13988be372d5673d12cf3e060"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a51111ac13988be372d5673d12cf3e060">dlc</a></td></tr>
<tr class="memitem:a51111ac13988be372d5673d12cf3e060" id="r_a51111ac13988be372d5673d12cf3e060"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a51111ac13988be372d5673d12cf3e060">dlc</a></td></tr>
<tr class="separator:a51111ac13988be372d5673d12cf3e060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3c54055c0cbceb73adf551f7067f23"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">pgn</a></td></tr>
<tr class="memitem:a1d3c54055c0cbceb73adf551f7067f23" id="r_a1d3c54055c0cbceb73adf551f7067f23"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">pgn</a></td></tr>
<tr class="separator:a1d3c54055c0cbceb73adf551f7067f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2551102670c4a540fced4c71da0b369d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a2551102670c4a540fced4c71da0b369d">hasPgn</a></td></tr>
<tr class="memitem:a2551102670c4a540fced4c71da0b369d" id="r_a2551102670c4a540fced4c71da0b369d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a2551102670c4a540fced4c71da0b369d">hasPgn</a></td></tr>
<tr class="separator:a2551102670c4a540fced4c71da0b369d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad78241dc40c793aabb8495b6989b81a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ad78241dc40c793aabb8495b6989b81a9">transmitter</a></td></tr>
<tr class="memitem:ad78241dc40c793aabb8495b6989b81a9" id="r_ad78241dc40c793aabb8495b6989b81a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ad78241dc40c793aabb8495b6989b81a9">transmitter</a></td></tr>
<tr class="separator:ad78241dc40c793aabb8495b6989b81a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25819ef907a32391af5c9f7cae9cdb22"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a25819ef907a32391af5c9f7cae9cdb22">comment</a></td></tr>
<tr class="memitem:a25819ef907a32391af5c9f7cae9cdb22" id="r_a25819ef907a32391af5c9f7cae9cdb22"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a25819ef907a32391af5c9f7cae9cdb22">comment</a></td></tr>
<tr class="separator:a25819ef907a32391af5c9f7cae9cdb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f4e71bbdec3f424b625e724e3dfbf14"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structDecodeSignal.html">DecodeSignal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a7f4e71bbdec3f424b625e724e3dfbf14">public</a></td></tr>
<tr class="memitem:a7f4e71bbdec3f424b625e724e3dfbf14" id="r_a7f4e71bbdec3f424b625e724e3dfbf14"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structDecodeSignal.html">DecodeSignal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a7f4e71bbdec3f424b625e724e3dfbf14">public</a></td></tr>
<tr class="separator:a7f4e71bbdec3f424b625e724e3dfbf14"><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 >Runtime-ready frame definition. </p>
<div class="textblock"><p>Runtime-ready frame definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00072">72</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00061">61</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae6ae88ee29bcaff936e7c7b2380f96b4" name="ae6ae88ee29bcaff936e7c7b2380f96b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ae88ee29bcaff936e7c7b2380f96b4">&#9670;&nbsp;</a></span>DecodeFrame()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ae88ee29bcaff936e7c7b2380f96b4">&#9670;&#160;</a></span>DecodeFrame()</h2>
<div class="memitem">
<div class="memproto">
@@ -144,13 +151,13 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00083">83</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00072">72</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa0a7f8fd5bfde2148dfd0d838328f579" name="aa0a7f8fd5bfde2148dfd0d838328f579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0a7f8fd5bfde2148dfd0d838328f579">&#9670;&nbsp;</a></span>name</h2>
<h2 class="memtitle"><span class="permalink"><a href="#aa0a7f8fd5bfde2148dfd0d838328f579">&#9670;&#160;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
@@ -160,16 +167,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Frame name. </p>
<p>Frame name. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00073">73</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00062">62</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a52e10215388db7df8b541b9d9909edcf" name="a52e10215388db7df8b541b9d9909edcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e10215388db7df8b541b9d9909edcf">&#9670;&nbsp;</a></span>canId</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a52e10215388db7df8b541b9d9909edcf">&#9670;&#160;</a></span>canId</h2>
<div class="memitem">
<div class="memproto">
@@ -179,16 +186,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Normalized CAN ID. </p>
<p>Normalized CAN ID. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00074">74</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00063">63</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a3ee2348d781f8f15aaf87e8dcf57ec41" name="a3ee2348d781f8f15aaf87e8dcf57ec41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee2348d781f8f15aaf87e8dcf57ec41">&#9670;&nbsp;</a></span>isExtended</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee2348d781f8f15aaf87e8dcf57ec41">&#9670;&#160;</a></span>isExtended</h2>
<div class="memitem">
<div class="memproto">
@@ -198,16 +205,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >true for extended frame. </p>
<p>true for extended frame. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00075">75</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00064">64</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a51111ac13988be372d5673d12cf3e060" name="a51111ac13988be372d5673d12cf3e060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51111ac13988be372d5673d12cf3e060">&#9670;&nbsp;</a></span>dlc</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a51111ac13988be372d5673d12cf3e060">&#9670;&#160;</a></span>dlc</h2>
<div class="memitem">
<div class="memproto">
@@ -217,16 +224,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Payload length. </p>
<p>Payload length. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00076">76</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00065">65</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a1d3c54055c0cbceb73adf551f7067f23" name="a1d3c54055c0cbceb73adf551f7067f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3c54055c0cbceb73adf551f7067f23">&#9670;&nbsp;</a></span>pgn</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3c54055c0cbceb73adf551f7067f23">&#9670;&#160;</a></span>pgn</h2>
<div class="memitem">
<div class="memproto">
@@ -236,16 +243,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >PGN if available. </p>
<p>PGN if available. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00077">77</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00066">66</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a2551102670c4a540fced4c71da0b369d" name="a2551102670c4a540fced4c71da0b369d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2551102670c4a540fced4c71da0b369d">&#9670;&nbsp;</a></span>hasPgn</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a2551102670c4a540fced4c71da0b369d">&#9670;&#160;</a></span>hasPgn</h2>
<div class="memitem">
<div class="memproto">
@@ -255,16 +262,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >true if PGN is valid. </p>
<p>true if PGN is valid. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00078">78</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00067">67</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="ad78241dc40c793aabb8495b6989b81a9" name="ad78241dc40c793aabb8495b6989b81a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad78241dc40c793aabb8495b6989b81a9">&#9670;&nbsp;</a></span>transmitter</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ad78241dc40c793aabb8495b6989b81a9">&#9670;&#160;</a></span>transmitter</h2>
<div class="memitem">
<div class="memproto">
@@ -274,16 +281,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Transmitter ECU. </p>
<p>Transmitter ECU. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00079">79</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00068">68</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a25819ef907a32391af5c9f7cae9cdb22" name="a25819ef907a32391af5c9f7cae9cdb22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25819ef907a32391af5c9f7cae9cdb22">&#9670;&nbsp;</a></span>comment</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a25819ef907a32391af5c9f7cae9cdb22">&#9670;&#160;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
@@ -293,16 +300,16 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Frame comment. </p>
<p>Frame comment. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00080">80</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00069">69</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a7f4e71bbdec3f424b625e724e3dfbf14" name="a7f4e71bbdec3f424b625e724e3dfbf14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f4e71bbdec3f424b625e724e3dfbf14">&#9670;&nbsp;</a></span>public</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a7f4e71bbdec3f424b625e724e3dfbf14">&#9670;&#160;</a></span>public</h2>
<div class="memitem">
<div class="memproto">
@@ -312,9 +319,9 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p >Signal definitions. </p>
<p>Signal definitions. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00081">81</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00070">70</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
@@ -327,7 +334,7 @@ Public Attributes</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structDecodeFrame.html">DecodeFrame</a></li>
<li class="footer">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.4 </li>
<li class="footer">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.8 </li>
</ul>
</div>
</body>