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

Generated foxygen documentation. Closes #1

Browse Source
This commit is contained in:
deeaitch
2026-06-14 20:51:56 -04:00
parent e2c07dde0d
commit dfec39d996
164 changed files with 25311 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
docs/html/structRawCanFrame.html Normal file
View File

@@ -0,0 +1,174 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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: RawCanFrame 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="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">DBC framework
</div>
</td>
</tr>
</tbody>
</table>
</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>
</div><!-- top -->
<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="structRawCanFrame-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RawCanFrame Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Raw CAN frame used for runtime or trace decoding.
<a href="structRawCanFrame.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.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:a17d18b39bed45e69f4e17ae2838f07f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRawCanFrame.html#a17d18b39bed45e69f4e17ae2838f07f7">RawCanFrame</a> ()</td></tr>
<tr class="separator:a17d18b39bed45e69f4e17ae2838f07f7"><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:a2d0e7fa0e3d5c20bbed55ed8f7888ff4"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRawCanFrame.html#a2d0e7fa0e3d5c20bbed55ed8f7888ff4">canId</a></td></tr>
<tr class="separator:a2d0e7fa0e3d5c20bbed55ed8f7888ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a462193d275adc1dba8bd18ffa0e36bb7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRawCanFrame.html#a462193d275adc1dba8bd18ffa0e36bb7">isExtended</a></td></tr>
<tr class="separator:a462193d275adc1dba8bd18ffa0e36bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0acb487612104c99c9907344c035df83"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRawCanFrame.html#a0acb487612104c99c9907344c035df83">data</a></td></tr>
<tr class="separator:a0acb487612104c99c9907344c035df83"><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 >Raw CAN frame used for runtime or trace decoding. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00023">23</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a17d18b39bed45e69f4e17ae2838f07f7" name="a17d18b39bed45e69f4e17ae2838f07f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17d18b39bed45e69f4e17ae2838f07f7">&#9670;&nbsp;</a></span>RawCanFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RawCanFrame::RawCanFrame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00028">28</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2d0e7fa0e3d5c20bbed55ed8f7888ff4" name="a2d0e7fa0e3d5c20bbed55ed8f7888ff4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d0e7fa0e3d5c20bbed55ed8f7888ff4">&#9670;&nbsp;</a></span>canId</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t RawCanFrame::canId</td>
</tr>
</table>
</div><div class="memdoc">
<p >Normalized CAN ID. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00024">24</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>, and <a class="el" href="main_8cpp_source.html#l00097">main()</a>.</p>
</div>
</div>
<a id="a0acb487612104c99c9907344c035df83" name="a0acb487612104c99c9907344c035df83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0acb487612104c99c9907344c035df83">&#9670;&nbsp;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::uint8_t&gt; RawCanFrame::data</td>
</tr>
</table>
</div><div class="memdoc">
<p >Payload bytes. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00026">26</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>, and <a class="el" href="main_8cpp_source.html#l00097">main()</a>.</p>
</div>
</div>
<a id="a462193d275adc1dba8bd18ffa0e36bb7" name="a462193d275adc1dba8bd18ffa0e36bb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a462193d275adc1dba8bd18ffa0e36bb7">&#9670;&nbsp;</a></span>isExtended</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RawCanFrame::isExtended</td>
</tr>
</table>
</div><div class="memdoc">
<p >true for extended frame. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00025">25</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>, and <a class="el" href="main_8cpp_source.html#l00097">main()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
</body>
</html>