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

264
docs/html/structFrameInfo.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: FrameInfo Struct Reference</title>
<title>DBC Framework: FrameInfo 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('structFrameInfo.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="structFrameInfo-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">FrameInfo Struct Reference</div></div>
@@ -58,11 +95,6 @@
<p><code>#include &lt;<a class="el" href="frame__info_8h_source.html">frame_info.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:a7f2d192b7969f7b60479a48e1f7eba61"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a7f2d192b7969f7b60479a48e1f7eba61">FrameInfo</a> ()</td></tr>
<tr class="separator:a7f2d192b7969f7b60479a48e1f7eba61"><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:abb53a7f93ed7abc0ea1ae4a8ccafcdcb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">name</a></td></tr>
@@ -81,8 +113,8 @@ Public Attributes</h2></td></tr>
<tr class="separator:a92749ec3798d4211a505860fb389a9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace75121294f9d89b762080ab5643293c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#ace75121294f9d89b762080ab5643293c">comment</a></td></tr>
<tr class="separator:ace75121294f9d89b762080ab5643293c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a942937027f1af06536f98cc23b2bf6ce"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structSignalInfo.html">SignalInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a942937027f1af06536f98cc23b2bf6ce">signals</a></td></tr>
<tr class="separator:a942937027f1af06536f98cc23b2bf6ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7e25d67ddae22f2ed50823a5a26084"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structSignalInfo.html">SignalInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a3f7e25d67ddae22f2ed50823a5a26084">public</a></td></tr>
<tr class="separator:a3f7e25d67ddae22f2ed50823a5a26084"><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 >Describes one CAN frame from a DBC file. </p>
@@ -117,6 +149,25 @@ Public Attributes</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abb53a7f93ed7abc0ea1ae4a8ccafcdcb" name="abb53a7f93ed7abc0ea1ae4a8ccafcdcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string FrameInfo::name</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame name. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00025">25</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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="af470b0742c05bfbffc31c51a68f5c05e" name="af470b0742c05bfbffc31c51a68f5c05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af470b0742c05bfbffc31c51a68f5c05e">&#9670;&nbsp;</a></span>canId</h2>
@@ -132,64 +183,7 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00026">26</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
</div>
</div>
<a id="ace75121294f9d89b762080ab5643293c" name="ace75121294f9d89b762080ab5643293c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace75121294f9d89b762080ab5643293c">&#9670;&nbsp;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string FrameInfo::comment</td>
</tr>
</table>
</div><div class="memdoc">
<p >Optional frame comment. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00032">32</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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__parser_8cpp_source.html#l00274">DbcParser::ParseCommentLine()</a>.</p>
</div>
</div>
<a id="aa2b198ea0f55e560c123d35e7b3ecab9" name="aa2b198ea0f55e560c123d35e7b3ecab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2b198ea0f55e560c123d35e7b3ecab9">&#9670;&nbsp;</a></span>dlc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t FrameInfo::dlc</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame payload length. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00030">30</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
</div>
</div>
<a id="a4737a5420213ad4304724e39f3a4e55d" name="a4737a5420213ad4304724e39f3a4e55d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4737a5420213ad4304724e39f3a4e55d">&#9670;&nbsp;</a></span>hasPgn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FrameInfo::hasPgn</td>
</tr>
</table>
</div><div class="memdoc">
<p >true if PGN was derived. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00029">29</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
@@ -208,26 +202,7 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00027">27</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</a>.</p>
</div>
</div>
<a id="abb53a7f93ed7abc0ea1ae4a8ccafcdcb" name="abb53a7f93ed7abc0ea1ae4a8ccafcdcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string FrameInfo::name</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame name. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00025">25</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
@@ -246,26 +221,45 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00028">28</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</a>, and <a class="el" href="main_8cpp_source.html#l00023">PrintTree()</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="a942937027f1af06536f98cc23b2bf6ce" name="a942937027f1af06536f98cc23b2bf6ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a942937027f1af06536f98cc23b2bf6ce">&#9670;&nbsp;</a></span>signals</h2>
<a id="a4737a5420213ad4304724e39f3a4e55d" name="a4737a5420213ad4304724e39f3a4e55d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4737a5420213ad4304724e39f3a4e55d">&#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="structSignalInfo.html">SignalInfo</a>&gt; FrameInfo::signals</td>
<td class="memname">bool FrameInfo::hasPgn</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signals contained in the frame. </p>
<p >true if PGN was derived. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00033">33</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00029">29</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <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__parser_8cpp_source.html#l00349">DbcParser::FindSignalByName()</a>, and <a class="el" href="dbc__parser_8cpp_source.html#l00040">DbcParser::ParseFile()</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="aa2b198ea0f55e560c123d35e7b3ecab9" name="aa2b198ea0f55e560c123d35e7b3ecab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2b198ea0f55e560c123d35e7b3ecab9">&#9670;&nbsp;</a></span>dlc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t FrameInfo::dlc</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame payload length. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00030">30</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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>
@@ -284,7 +278,43 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00031">31</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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__parser_8cpp_source.html#l00142">DbcParser::ParseFrameLine()</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="ace75121294f9d89b762080ab5643293c" name="ace75121294f9d89b762080ab5643293c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace75121294f9d89b762080ab5643293c">&#9670;&nbsp;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string FrameInfo::comment</td>
</tr>
</table>
</div><div class="memdoc">
<p >Optional frame comment. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00032">32</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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="a3f7e25d67ddae22f2ed50823a5a26084" name="a3f7e25d67ddae22f2ed50823a5a26084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f7e25d67ddae22f2ed50823a5a26084">&#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="structSignalInfo.html">SignalInfo</a>&gt; FrameInfo::public</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signals contained in the frame. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00033">33</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
@@ -292,9 +322,13 @@ Public Attributes</h2></td></tr>
<li><a class="el" href="frame__info_8h_source.html">frame_info.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="structFrameInfo.html">FrameInfo</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>