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

update documentation

Browse Source
This commit is contained in:
deeaitch committed 2026-10-07 20:14:24 -04:00
1 parent 1d56a37090
commit 21d6f12163
190 files changed
+9608 -2928
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/structDecodeFrame.html
+21 -49
View File
@@ -106,15 +106,15 @@ $(document).ready(function(){initNavTree('structDecodeFrame.html',''); initResiz
Public Attributes</h2></td></tr>
<tr class="memitem:aa0a7f8fd5bfde2148dfd0d838328f579" id="r_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>
<tr class="separator:aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e10215388db7df8b541b9d9909edcf" id="r_a52e10215388db7df8b541b9d9909edcf"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">canId</a></td></tr>
<tr class="memitem:a52e10215388db7df8b541b9d9909edcf" id="r_a52e10215388db7df8b541b9d9909edcf"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">canId</a> = 0U</td></tr>
<tr class="separator:a52e10215388db7df8b541b9d9909edcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee2348d781f8f15aaf87e8dcf57ec41" id="r_a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">isExtended</a></td></tr>
<tr class="memitem:a3ee2348d781f8f15aaf87e8dcf57ec41" id="r_a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">isExtended</a> = false</td></tr>
<tr class="separator:a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51111ac13988be372d5673d12cf3e060" id="r_a51111ac13988be372d5673d12cf3e060"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a51111ac13988be372d5673d12cf3e060">dlc</a></td></tr>
<tr class="memitem:a51111ac13988be372d5673d12cf3e060" id="r_a51111ac13988be372d5673d12cf3e060"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a51111ac13988be372d5673d12cf3e060">dlc</a> = 0U</td></tr>
<tr class="separator:a51111ac13988be372d5673d12cf3e060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3c54055c0cbceb73adf551f7067f23" id="r_a1d3c54055c0cbceb73adf551f7067f23"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">pgn</a></td></tr>
<tr class="memitem:a1d3c54055c0cbceb73adf551f7067f23" id="r_a1d3c54055c0cbceb73adf551f7067f23"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">pgn</a> = 0U</td></tr>
<tr class="separator:a1d3c54055c0cbceb73adf551f7067f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2551102670c4a540fced4c71da0b369d" id="r_a2551102670c4a540fced4c71da0b369d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a2551102670c4a540fced4c71da0b369d">hasPgn</a></td></tr>
<tr class="memitem:a2551102670c4a540fced4c71da0b369d" id="r_a2551102670c4a540fced4c71da0b369d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a2551102670c4a540fced4c71da0b369d">hasPgn</a> = false</td></tr>
<tr class="separator:a2551102670c4a540fced4c71da0b369d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad78241dc40c793aabb8495b6989b81a9" id="r_ad78241dc40c793aabb8495b6989b81a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ad78241dc40c793aabb8495b6989b81a9">transmitter</a></td></tr>
<tr class="separator:ad78241dc40c793aabb8495b6989b81a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -126,36 +126,8 @@ Public Attributes</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Runtime-ready frame definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00061">61</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae6ae88ee29bcaff936e7c7b2380f96b4" name="ae6ae88ee29bcaff936e7c7b2380f96b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ae88ee29bcaff936e7c7b2380f96b4">&#9670;&#160;</a></span>DecodeFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DecodeFrame::DecodeFrame </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="decode__database_8h_source.html#l00072">72</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00063">63</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aa0a7f8fd5bfde2148dfd0d838328f579" name="aa0a7f8fd5bfde2148dfd0d838328f579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0a7f8fd5bfde2148dfd0d838328f579">&#9670;&#160;</a></span>name</h2>
@@ -169,7 +141,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Frame name. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00062">62</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#l00064">64</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>
@@ -182,13 +154,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeFrame::canId</td>
<td class="memname">std::uint32_t DecodeFrame::canId = 0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Normalized CAN ID. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00063">63</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#l00065">65</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>
@@ -201,13 +173,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeFrame::isExtended</td>
<td class="memname">bool DecodeFrame::isExtended = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>true for extended frame. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00064">64</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#l00066">66</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>
@@ -220,13 +192,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t DecodeFrame::dlc</td>
<td class="memname">std::uint8_t DecodeFrame::dlc = 0U</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#l00065">65</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#l00067">67</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>
@@ -239,13 +211,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeFrame::pgn</td>
<td class="memname">std::uint32_t DecodeFrame::pgn = 0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>PGN if available. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00066">66</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#l00068">68</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>
@@ -258,13 +230,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeFrame::hasPgn</td>
<td class="memname">bool DecodeFrame::hasPgn = false</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#l00067">67</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#l00069">69</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>
@@ -283,7 +255,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Transmitter ECU. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00068">68</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#l00070">70</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>
@@ -302,7 +274,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Frame comment. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00069">69</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#l00071">71</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>
@@ -321,7 +293,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Signal definitions. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00070">70</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#l00072">72</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>