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 - Variables</title>
<title>DBC Framework: Class Members - Variables</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,50 +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 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><a href="functions_func.html"><span>Functions</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_h"><span>h</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</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><a href="#index_u"><span>u</span></a></li>
<li class="current"><a href="#index_v"><span>v</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_vars.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;
@@ -80,7 +91,7 @@
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>canId&#160;:&#160;<a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#af470b0742c05bfbffc31c51a68f5c05e">FrameInfo</a>, <a class="el" href="structFrameKey.html#a022917652b4d3c2f2dfcc5a13ab7caa4">FrameKey</a>, <a class="el" href="structRawCanFrame.html#a2d0e7fa0e3d5c20bbed55ed8f7888ff4">RawCanFrame</a></li>
<li>canId&#160;:&#160;<a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#af470b0742c05bfbffc31c51a68f5c05e">FrameInfo</a>, <a class="el" href="structRawCanFrame.html#a2d0e7fa0e3d5c20bbed55ed8f7888ff4">RawCanFrame</a></li>
<li>comment&#160;:&#160;<a class="el" href="structDecodeFrame.html#a25819ef907a32391af5c9f7cae9cdb22">DecodeFrame</a>, <a class="el" href="structDecodeSignal.html#ae28c905d4a2bc86419c2a8361bfea473">DecodeSignal</a>, <a class="el" href="structFrameInfo.html#ace75121294f9d89b762080ab5643293c">FrameInfo</a>, <a class="el" href="structSignalInfo.html#ac99ba7563a5dad01e39c4257216953f5">SignalInfo</a></li>
</ul>
@@ -94,8 +105,7 @@
<h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
<li>factor&#160;:&#160;<a class="el" href="structDecodeSignal.html#a428c39913a366a8476dd291061354391">DecodeSignal</a>, <a class="el" href="structSignalInfo.html#ae4f78d99a2750aa564d7eba860171499">SignalInfo</a></li>
<li>frameIndexByKey&#160;:&#160;<a class="el" href="structDecodeDatabase.html#ae4fd1351008bb0dce337821a849100c5">DecodeDatabase</a></li>
<li>frames&#160;:&#160;<a class="el" href="structDbcDatabase.html#a2cade5d0234ee816132127542f8c612b">DbcDatabase</a>, <a class="el" href="structDecodeDatabase.html#a2bd4ddfc2602c1de4e12a373bfc93072">DecodeDatabase</a></li>
<li>frames&#160;:&#160;<a class="el" href="structDbcDatabase.html#a2cade5d0234ee816132127542f8c612b">DbcDatabase</a></li>
</ul>
@@ -105,7 +115,7 @@
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>isExtended&#160;:&#160;<a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#a34b726afaad2ac5c697fdb2ac070cdaf">FrameInfo</a>, <a class="el" href="structFrameKey.html#aa3179b709d02ef70cf0e736f040a2145">FrameKey</a>, <a class="el" href="structRawCanFrame.html#a462193d275adc1dba8bd18ffa0e36bb7">RawCanFrame</a></li>
<li>isExtended&#160;:&#160;<a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#a34b726afaad2ac5c697fdb2ac070cdaf">FrameInfo</a>, <a class="el" href="structRawCanFrame.html#a462193d275adc1dba8bd18ffa0e36bb7">RawCanFrame</a></li>
<li>isLittleEndian&#160;:&#160;<a class="el" href="structSignalInfo.html#af363b1563fb4c7cc8973f9a80c06846c">SignalInfo</a></li>
<li>isSigned&#160;:&#160;<a class="el" href="structSignalInfo.html#a52a52b320eef92fbcb4626307f9a498f">SignalInfo</a></li>
</ul>
@@ -117,11 +127,6 @@
<h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
<li>m_children&#160;:&#160;<a class="el" href="classTreeNode.html#a1bd61f40df6d36e61021063e3816a351">TreeNode</a></li>
<li>m_frame&#160;:&#160;<a class="el" href="classTreeNode.html#a77ee6aa80774d67ba442a66b45c798c2">TreeNode</a></li>
<li>m_name&#160;:&#160;<a class="el" href="classTreeNode.html#ac0ddcb8370e6b51e2d3de6b8211a47f8">TreeNode</a></li>
<li>m_signal&#160;:&#160;<a class="el" href="classTreeNode.html#ae658355007bc9303f7bfae3bb3ec8386">TreeNode</a></li>
<li>m_type&#160;:&#160;<a class="el" href="classTreeNode.html#a04bccab9e60a6a78777cd7dfec52d224">TreeNode</a></li>
<li>maximum&#160;:&#160;<a class="el" href="structDecodeSignal.html#a4a6ba87142a9badbf0ca830e9e709cb7">DecodeSignal</a>, <a class="el" href="structSignalInfo.html#adf1c4331b9eabced0d7fdda40ff0eb52">SignalInfo</a></li>
<li>minimum&#160;:&#160;<a class="el" href="structDecodeSignal.html#a0fb84e19a0ab3bd50b6f65c1075ebc25">DecodeSignal</a>, <a class="el" href="structSignalInfo.html#ada7bf94fbeaa26bd08c73982b5af255b">SignalInfo</a></li>
</ul>
@@ -140,6 +145,7 @@
<h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
<li>pgn&#160;:&#160;<a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#aee518b33f1000bf0b7f6e4a87474c943">FrameInfo</a></li>
<li>physicalValue&#160;:&#160;<a class="el" href="structDecodedSignalValue.html#a6847d05b3cb00d5e0f6c611968f57978">DecodedSignalValue</a></li>
<li>public&#160;:&#160;<a class="el" href="structDecodedFrameValue.html#adae123ac7fbb4a5c314b64b01109f4a8">DecodedFrameValue</a>, <a class="el" href="structDecodeFrame.html#a7f4e71bbdec3f424b625e724e3dfbf14">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#a3f7e25d67ddae22f2ed50823a5a26084">FrameInfo</a></li>
</ul>
@@ -150,7 +156,6 @@
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>signals&#160;:&#160;<a class="el" href="structDecodedFrameValue.html#a8440e0e5d7953102095b029f522022d3">DecodedFrameValue</a>, <a class="el" href="structDecodeFrame.html#a372afd9e74f1ae33f85cb4acfd3e2036">DecodeFrame</a>, <a class="el" href="structFrameInfo.html#a942937027f1af06536f98cc23b2bf6ce">FrameInfo</a></li>
<li>startBit&#160;:&#160;<a class="el" href="structDecodeSignal.html#aaf5d7527ddf65b6355c2b4f3626df22d">DecodeSignal</a>, <a class="el" href="structSignalInfo.html#ace290724f9801521609aedaa946d61f1">SignalInfo</a></li>
</ul>
@@ -170,9 +175,12 @@
<li>valueType&#160;:&#160;<a class="el" href="structDecodeSignal.html#a9d37638129263b8902ba5be59baf39a8">DecodeSignal</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>