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: Class Members - Functions</title>
<title>DBC Framework: Class Members - Functions</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,149 +35,75 @@
</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_func.html"><span>Functions</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li class="current"><a href="#index__7E"><span>~</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('functions_func.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="contents">
&#160;
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
&#160;<ul>
<li>AddChild()&#160;:&#160;<a class="el" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">TreeNode</a></li>
</ul>
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
<li>Build()&#160;:&#160;<a class="el" href="classDbcDecodeBuilder.html#a2bc6386dfb5e58976c42e22c19ec471b">DbcDecodeBuilder</a>, <a class="el" href="classDbcTreeBuilder.html#a7e57d067d831b14b383947fd125edd4b">DbcTreeBuilder</a></li>
</ul>
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
<li>Decode()&#160;:&#160;<a class="el" href="classDbcDecoder.html#a345951ffe5d943a70d3a1ea1f39e74f7">DbcDecoder</a></li>
<li>DecodedFrameValue()&#160;:&#160;<a class="el" href="structDecodedFrameValue.html#a19f754bb84e67e6ae71ea93b9ae6382b">DecodedFrameValue</a></li>
<li>DecodedSignalValue()&#160;:&#160;<a class="el" href="structDecodedSignalValue.html#a1481b122a7ce5a618012b1133c6adedf">DecodedSignalValue</a></li>
<li>DecodeFrame()&#160;:&#160;<a class="el" href="structDecodeFrame.html#ae6ae88ee29bcaff936e7c7b2380f96b4">DecodeFrame</a></li>
<li>DecodeSignal()&#160;:&#160;<a class="el" href="structDecodeSignal.html#a93fd97267e2614979440261628e493f5">DecodeSignal</a></li>
</ul>
<h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
<li>ExtractIntel()&#160;:&#160;<a class="el" href="classDbcDecoder.html#aba130165c1a73bb4cd3a0454f415d872">DbcDecoder</a></li>
<li>ExtractMotorola()&#160;:&#160;<a class="el" href="classDbcDecoder.html#aede690734148c3d538105d5a2f7ee0a9">DbcDecoder</a></li>
<li>ExtractUnsigned()&#160;:&#160;<a class="el" href="classDbcDecoder.html#a2a8a99b1107543be6fd1b3f891130bf5">DbcDecoder</a></li>
</ul>
<h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
<li>FindFrame()&#160;:&#160;<a class="el" href="classDbcDecoder.html#ab2cfb2fb711c95d3a29365546b89f3da">DbcDecoder</a></li>
<li>FindFrameById()&#160;:&#160;<a class="el" href="classDbcParser.html#ab1fee32cb845573ce10949b4bec721f9">DbcParser</a></li>
<li>FindSignalByName()&#160;:&#160;<a class="el" href="classDbcParser.html#ab7b95be4433c56cc855bedb08b96a71a">DbcParser</a></li>
<li>FrameInfo()&#160;:&#160;<a class="el" href="structFrameInfo.html#a7f2d192b7969f7b60479a48e1f7eba61">FrameInfo</a></li>
<li>FrameKey()&#160;:&#160;<a class="el" href="structFrameKey.html#a0e9aad56b251cdf802d45a9c19050b14">FrameKey</a></li>
</ul>
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
<li>GetChild()&#160;:&#160;<a class="el" href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6">TreeNode</a></li>
<li>GetChildCount()&#160;:&#160;<a class="el" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">TreeNode</a></li>
<li>GetFrame()&#160;:&#160;<a class="el" href="classTreeNode.html#afc503b40004764163605d6dbdb4ef811">TreeNode</a></li>
<li>GetName()&#160;:&#160;<a class="el" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">TreeNode</a></li>
<li>GetSignal()&#160;:&#160;<a class="el" href="classTreeNode.html#a226518612d0d00b5988a2c44fc21d3f1">TreeNode</a></li>
<li>GetType()&#160;:&#160;<a class="el" href="classTreeNode.html#afa2f4b0aafa12d3d41ed00df8e0250c9">TreeNode</a></li>
</ul>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>IsCommentLine()&#160;:&#160;<a class="el" href="classDbcParser.html#ae3488a0a6c64dc95e4ed289e77579feb">DbcParser</a></li>
<li>IsFrameLine()&#160;:&#160;<a class="el" href="classDbcParser.html#ada086584d371c08dd93b75fb7965f13b">DbcParser</a></li>
<li>IsSignalLine()&#160;:&#160;<a class="el" href="classDbcParser.html#ace3d3432a55707bc286a994aa205fed1">DbcParser</a></li>
</ul>
<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
<li>NormalizeCanId()&#160;:&#160;<a class="el" href="classDbcParser.html#a94d140d9442e4989b5b2ea7662c2debf">DbcParser</a></li>
</ul>
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
<li>operator()()&#160;:&#160;<a class="el" href="structFrameKeyHasher.html#a1612ce56b513790e3ed4c06ec7d28b9f">FrameKeyHasher</a></li>
<li>operator=()&#160;:&#160;<a class="el" href="classTreeNode.html#ad6ce97dcf532b452d520452b6d000daa">TreeNode</a></li>
<li>operator==()&#160;:&#160;<a class="el" href="structFrameKey.html#aaaec9f914e127787247fcda5e183b01f">FrameKey</a></li>
</ul>
<h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
<li>ParseCommentLine()&#160;:&#160;<a class="el" href="classDbcParser.html#aa662b34694fd8b3edd757f36cb064c5c">DbcParser</a></li>
<li>ParseFile()&#160;:&#160;<a class="el" href="classDbcParser.html#aef72826942c9095d653fafa435855e56">DbcParser</a></li>
<li>ParseFrameLine()&#160;:&#160;<a class="el" href="classDbcParser.html#a6d73bb1885e59aecd8202e93a7cd392a">DbcParser</a></li>
<li>ParseSignalLine()&#160;:&#160;<a class="el" href="classDbcParser.html#a4cbce88d08b1f72903ecf1bce41de5d2">DbcParser</a></li>
</ul>
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>RawCanFrame()&#160;:&#160;<a class="el" href="structRawCanFrame.html#a17d18b39bed45e69f4e17ae2838f07f7">RawCanFrame</a></li>
</ul>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>SignalInfo()&#160;:&#160;<a class="el" href="structSignalInfo.html#aa2d2cd238118015258e271dce92a971e">SignalInfo</a></li>
<li>SignExtend()&#160;:&#160;<a class="el" href="classDbcDecoder.html#a41e89e343338088d27e46773fa52df42">DbcDecoder</a></li>
<li>SplitReceivers()&#160;:&#160;<a class="el" href="classDbcParser.html#a0c1cc3c58f33473bf426a77b7a25c529">DbcParser</a></li>
</ul>
<h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
<li>TreeNode()&#160;:&#160;<a class="el" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a></li>
<li>Trim()&#160;:&#160;<a class="el" href="classDbcParser.html#a1ae77c4c356af3d7b01a30044366f02b">DbcParser</a></li>
<li>TryExtractPgn()&#160;:&#160;<a class="el" href="classDbcParser.html#a8a7e8fc517e40beab87a8a1dbad2b324">DbcParser</a></li>
</ul>
<h3><a id="index__7E" name="index__7E"></a>- ~ -</h3><ul>
<li>~TreeNode()&#160;:&#160;<a class="el" href="classTreeNode.html#a89eb1eb0e25fccaa83c780b85f95b570">TreeNode</a></li>
</ul>
</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="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>