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

upfate doxygen

Browse Source
This commit is contained in:
deeaitch committed 2026-10-20 13:40:44 -04:00
1 parent a55d1c58ed
commit c43222939f
433 files changed
+15617 -7061
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/structDecodeFrame.html
+82 -14
View File
@@ -106,6 +106,7 @@ $(document).ready(function(){initNavTree('structDecodeFrame.html',''); initResiz
<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:a05e3d1c6143367553c2c3beba82a5c34" id="r_a05e3d1c6143367553c2c3beba82a5c34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFrameKey.html">FrameKey</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a05e3d1c6143367553c2c3beba82a5c34">GetKey</a> () const</td></tr>
<tr class="memdesc:a05e3d1c6143367553c2c3beba82a5c34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the stable normalized frame identifier. <br /></td></tr>
<tr class="separator:a05e3d1c6143367553c2c3beba82a5c34"><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>
@@ -128,11 +129,17 @@ Public Attributes</h2></td></tr>
<tr class="separator:a25819ef907a32391af5c9f7cae9cdb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f4e71bbdec3f424b625e724e3dfbf14" id="r_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>
<tr class="memitem:ad506b03108a40df7e8005638c9c59653" id="r_ad506b03108a40df7e8005638c9c59653"><td class="memItemLeft" align="right" valign="top">AttributeMap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ad506b03108a40df7e8005638c9c59653">attributes</a></td></tr>
<tr class="separator:ad506b03108a40df7e8005638c9c59653"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a475e669f390491a4d99383d3fee51300" id="r_a475e669f390491a4d99383d3fee51300"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a475e669f390491a4d99383d3fee51300">frameFormat</a></td></tr>
<tr class="separator:a475e669f390491a4d99383d3fee51300"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a732c2f6853d55ce8253db61207fc21d3" id="r_a732c2f6853d55ce8253db61207fc21d3"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a732c2f6853d55ce8253db61207fc21d3">cycleTimeMs</a></td></tr>
<tr class="separator:a732c2f6853d55ce8253db61207fc21d3"><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>
<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#l00068">68</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>
@@ -157,7 +164,11 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<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>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="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>
</div>
</div>
@@ -175,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#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#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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -194,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#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#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>
<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>
</div>
</div>
@@ -213,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#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#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>.</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>
</div>
</div>
@@ -232,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#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#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>.</p>
@@ -251,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#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#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>
@@ -268,9 +279,9 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>true if PGN is valid. </p>
<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#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#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>
@@ -289,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#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#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>
@@ -308,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#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#l00015">DbcDecodeBuilder::Build()</a>.</p>
@@ -327,7 +338,64 @@ 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#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#l00077">77</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="ad506b03108a40df7e8005638c9c59653" name="ad506b03108a40df7e8005638c9c59653"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad506b03108a40df7e8005638c9c59653">&#9670;&#160;</a></span>attributes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AttributeMap DecodeFrame::attributes</td>
</tr>
</table>
</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="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a475e669f390491a4d99383d3fee51300" name="a475e669f390491a4d99383d3fee51300"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a475e669f390491a4d99383d3fee51300">&#9670;&#160;</a></span>frameFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt;std::string&gt; DecodeFrame::frameFormat</td>
</tr>
</table>
</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="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a732c2f6853d55ce8253db61207fc21d3" name="a732c2f6853d55ce8253db61207fc21d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a732c2f6853d55ce8253db61207fc21d3">&#9670;&#160;</a></span>cycleTimeMs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt;std::uint32_t&gt; DecodeFrame::cycleTimeMs</td>
</tr>
</table>
</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="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00015">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>