updated documentation

This commit is contained in:
2026-06-14 21:05:20 -04:00
parent 4c8af9f9fe
commit 38ce043ae0
232 changed files with 11959 additions and 4568 deletions

View File

@@ -5,10 +5,17 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DBC framework: main.cpp File Reference</title>
<title>DBC Framework: main.cpp File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
@@ -18,8 +25,9 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">DBC framework
<div id="projectname">DBC Framework
</div>
<div id="projectbrief">DBC parsing and CAN signal decoding framework</div>
</td>
</tr>
</tbody>
@@ -27,22 +35,53 @@
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('main_8cpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
@@ -66,10 +105,6 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a57aefef9cfd52a8190df002e12808e0a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a57aefef9cfd52a8190df002e12808e0a">PrintTree</a> (const <a class="el" href="classTreeNode.html">TreeNode</a> *node, int indent)</td></tr>
<tr class="separator:a57aefef9cfd52a8190df002e12808e0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26dbbea5b56e3fbc451b68f217d5063f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a26dbbea5b56e3fbc451b68f217d5063f">PrintDecodedFrame</a> (const <a class="el" href="structDecodedFrameValue.html">DecodedFrameValue</a> &amp;decoded)</td></tr>
<tr class="separator:a26dbbea5b56e3fbc451b68f217d5063f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddf1224851353fc92bfbff6f499fa97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a> (int argc, char *argv[])</td></tr>
<tr class="separator:a0ddf1224851353fc92bfbff6f499fa97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -107,88 +142,16 @@ Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00097">97</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__tree__builder_8cpp_source.html#l00014">DbcTreeBuilder::Build()</a>, <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__decoder_8h_source.html#l00024">RawCanFrame::canId</a>, <a class="el" href="dbc__decoder_8h_source.html#l00026">RawCanFrame::data</a>, <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>, <a class="el" href="decode__database_8h_source.html#l00133">DecodeDatabase::frames</a>, <a class="el" href="dbc__decoder_8h_source.html#l00025">RawCanFrame::isExtended</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00040">DbcParser::ParseFile()</a>, <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
</div>
</div>
<a id="a26dbbea5b56e3fbc451b68f217d5063f" name="a26dbbea5b56e3fbc451b68f217d5063f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26dbbea5b56e3fbc451b68f217d5063f">&#9670;&nbsp;</a></span>PrintDecodedFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PrintDecodedFrame </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structDecodedFrameValue.html">DecodedFrameValue</a> &amp;&#160;</td>
<td class="paramname"><em>decoded</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00075">75</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__decoder_8h_source.html#l00039">DecodedSignalValue::definition</a>, <a class="el" href="dbc__decoder_8h_source.html#l00056">DecodedFrameValue::definition</a>, <a class="el" href="decode__database_8h_source.html#l00040">DecodeSignal::name</a>, <a class="el" href="decode__database_8h_source.html#l00073">DecodeFrame::name</a>, <a class="el" href="dbc__decoder_8h_source.html#l00041">DecodedSignalValue::physicalValue</a>, <a class="el" href="dbc__decoder_8h_source.html#l00040">DecodedSignalValue::rawValue</a>, <a class="el" href="dbc__decoder_8h_source.html#l00057">DecodedFrameValue::signals</a>, <a class="el" href="decode__database_8h_source.html#l00049">DecodeSignal::unit</a>, <a class="el" href="dbc__decoder_8h_source.html#l00042">DecodedSignalValue::valid</a>, and <a class="el" href="dbc__decoder_8h_source.html#l00058">DecodedFrameValue::valid</a>.</p>
<p class="reference">Referenced by <a class="el" href="main_8cpp_source.html#l00097">main()</a>.</p>
</div>
</div>
<a id="a57aefef9cfd52a8190df002e12808e0a" name="a57aefef9cfd52a8190df002e12808e0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57aefef9cfd52a8190df002e12808e0a">&#9670;&nbsp;</a></span>PrintTree()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PrintTree </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTreeNode.html">TreeNode</a> *&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>indent</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00023">23</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p class="reference">References <a class="el" href="frame__info_8h_source.html#l00026">FrameInfo::canId</a>, <a class="el" href="frame__info_8h_source.html#l00030">FrameInfo::dlc</a>, <a class="el" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a3bb3e8c8a24891ba0f7608bcc96f8b0a">Frame</a>, <a class="el" href="tree__node_8cpp_source.html#l00047">TreeNode::GetChild()</a>, <a class="el" href="tree__node_8cpp_source.html#l00043">TreeNode::GetChildCount()</a>, <a class="el" href="tree__node_8cpp_source.html#l00069">TreeNode::GetFrame()</a>, <a class="el" href="tree__node_8cpp_source.html#l00065">TreeNode::GetName()</a>, <a class="el" href="tree__node_8cpp_source.html#l00073">TreeNode::GetSignal()</a>, <a class="el" href="tree__node_8cpp_source.html#l00061">TreeNode::GetType()</a>, <a class="el" href="frame__info_8h_source.html#l00029">FrameInfo::hasPgn</a>, <a class="el" href="frame__info_8h_source.html#l00027">FrameInfo::isExtended</a>, <a class="el" href="signal__info_8h_source.html#l00025">SignalInfo::length</a>, <a class="el" href="frame__info_8h_source.html#l00028">FrameInfo::pgn</a>, <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>, <a class="el" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16afa03eb688ad8aa1db593d33dabd89bad">Root</a>, <a class="el" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a085fea7abdc5d904fe69a3081efd7398">Signal</a>, <a class="el" href="signal__info_8h_source.html#l00024">SignalInfo::startBit</a>, and <a class="el" href="signal__info_8h_source.html#l00032">SignalInfo::unit</a>.</p>
<p class="reference">Referenced by <a class="el" href="main_8cpp_source.html#l00097">main()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 14 2026 20:49:34 for DBC framework 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.4
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="main_8cpp.html">main.cpp</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>
</ul>
</div>
</body>
</html>