automotive/dbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
deeaitch
2026-06-14 21:05:20 -04:00
parent 4c8af9f9fe
commit 38ce043ae0
232 changed files with 11959 additions and 4568 deletions
Download Patch File Download Diff File Expand all files Collapse all files

230
docs/html/structDecodeFrame.html
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: DecodeFrame Struct Reference</title>
<title>DBC Framework: DecodeFrame Struct 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,26 +35,55 @@
</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><a href="functions.html"><span>Class&#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('structDecodeFrame.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structDecodeFrame-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodeFrame Struct Reference</div></div>
@@ -58,11 +95,6 @@
<p><code>#include &lt;<a class="el" href="decode__database_8h_source.html">decode_database.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae6ae88ee29bcaff936e7c7b2380f96b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ae6ae88ee29bcaff936e7c7b2380f96b4">DecodeFrame</a> ()</td></tr>
<tr class="separator:ae6ae88ee29bcaff936e7c7b2380f96b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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>
@@ -81,8 +113,8 @@ Public Attributes</h2></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="separator:a25819ef907a32391af5c9f7cae9cdb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372afd9e74f1ae33f85cb4acfd3e2036"><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#a372afd9e74f1ae33f85cb4acfd3e2036">signals</a></td></tr>
<tr class="separator:a372afd9e74f1ae33f85cb4acfd3e2036"><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="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>
@@ -117,6 +149,25 @@ Public Attributes</h2></td></tr>
</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::name</td>
</tr>
</table>
</div><div class="memdoc">
<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="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>
@@ -134,63 +185,6 @@ Public Attributes</h2></td></tr>
<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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::comment</td>
</tr>
</table>
</div><div class="memdoc">
<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="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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t DecodeFrame::dlc</td>
</tr>
</table>
</div><div class="memdoc">
<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="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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeFrame::hasPgn</td>
</tr>
</table>
</div><div class="memdoc">
<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="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>
@@ -212,22 +206,22 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="aa0a7f8fd5bfde2148dfd0d838328f579" name="aa0a7f8fd5bfde2148dfd0d838328f579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0a7f8fd5bfde2148dfd0d838328f579">&#9670;&nbsp;</a></span>name</h2>
<a id="a51111ac13988be372d5673d12cf3e060" name="a51111ac13988be372d5673d12cf3e060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51111ac13988be372d5673d12cf3e060">&#9670;&nbsp;</a></span>dlc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::name</td>
<td class="memname">std::uint8_t DecodeFrame::dlc</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame name. </p>
<p >Payload length. </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#l00076">76</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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
@@ -250,22 +244,22 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a372afd9e74f1ae33f85cb4acfd3e2036" name="a372afd9e74f1ae33f85cb4acfd3e2036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a372afd9e74f1ae33f85cb4acfd3e2036">&#9670;&nbsp;</a></span>signals</h2>
<a id="a2551102670c4a540fced4c71da0b369d" name="a2551102670c4a540fced4c71da0b369d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2551102670c4a540fced4c71da0b369d">&#9670;&nbsp;</a></span>hasPgn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structDecodeSignal.html">DecodeSignal</a>&gt; DecodeFrame::signals</td>
<td class="memname">bool DecodeFrame::hasPgn</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signal definitions. </p>
<p >true if PGN is valid. </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#l00078">78</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>, and <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
@@ -286,15 +280,55 @@ Public Attributes</h2></td></tr>
<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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::comment</td>
</tr>
</table>
</div><div class="memdoc">
<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="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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structDecodeSignal.html">DecodeSignal</a>&gt; DecodeFrame::public</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="decode__database_8h_source.html">decode_database.h</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="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>
</ul>
</div>
</body>
</html>