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

update documentation

Browse Source
This commit is contained in:
deeaitch committed 2026-10-23 20:29:26 -04:00
1 parent 8d06165979
commit e44529007a
250 files changed
+8487 -5511
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/structDecodeFrame.html
+17 -17
View File
@@ -139,7 +139,7 @@ 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#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#l00069">69</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a05e3d1c6143367553c2c3beba82a5c34" name="a05e3d1c6143367553c2c3beba82a5c34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05e3d1c6143367553c2c3beba82a5c34">&#9670;&#160;</a></span>GetKey()</h2>
@@ -166,9 +166,9 @@ Public Attributes</h2></td></tr>
<p>Return the stable normalized frame identifier. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00086">86</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#l00087">87</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00070">canId</a>, and <a class="el" href="decode__database_8h_source.html#l00071">isExtended</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00071">canId</a>, and <a class="el" href="decode__database_8h_source.html#l00072">isExtended</a>.</p>
</div>
</div>
@@ -186,7 +186,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#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#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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -205,9 +205,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Normalized CAN ID. </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#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#l00015">DbcDecodeBuilder::Build()</a>, and <a class="el" href="decode__database_8h_source.html#l00086">GetKey()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>, and <a class="el" href="decode__database_8h_source.html#l00087">GetKey()</a>.</p>
</div>
</div>
@@ -224,9 +224,9 @@ Public Attributes</h2></td></tr>
</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#l00071">71</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>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>, and <a class="el" href="decode__database_8h_source.html#l00086">GetKey()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>, and <a class="el" href="decode__database_8h_source.html#l00087">GetKey()</a>.</p>
</div>
</div>
@@ -243,7 +243,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Payload length. </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>
<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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -262,7 +262,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>PGN if available. </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#l00074">74</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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -281,7 +281,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Explicit J1939 opt-in; pgn must match canId. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00074">74</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#l00075">75</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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -300,7 +300,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#l00075">75</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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -319,7 +319,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#l00076">76</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#l00077">77</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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -338,7 +338,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#l00077">77</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>
</div>
</div>
@@ -355,7 +355,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Effective attributes after defaults and overrides. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00079">79</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#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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -374,7 +374,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>VFrameFormat label, when declared. </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="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="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -393,7 +393,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>GenMsgCycleTime in milliseconds, when declared. </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#l00082">82</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#l00015">DbcDecodeBuilder::Build()</a>.</p>