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/classDecodeDatabase.html
+40 -9
View File
@@ -93,6 +93,7 @@ $(document).ready(function(){initNavTree('classDecodeDatabase.html',''); initRes
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classDecodeDatabase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodeDatabase Class Reference</div></div>
</div><!--header-->
@@ -116,11 +117,16 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a0af5b15b9953a4f6551c27ee9ae8b514" id="r_a0af5b15b9953a4f6551c27ee9ae8b514"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const <a class="el" href="structDecodeSignal.html">DecodeSignal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#a0af5b15b9953a4f6551c27ee9ae8b514">FindSignal</a> (const <a class="el" href="structSignalKey.html">SignalKey</a> &amp;key) const</td></tr>
<tr class="memdesc:a0af5b15b9953a4f6551c27ee9ae8b514"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an owning signal handle, or an empty handle for a missing key. <br /></td></tr>
<tr class="separator:a0af5b15b9953a4f6551c27ee9ae8b514"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ad69570a27f06c52ac92e1bbd01d613ff" id="r_ad69570a27f06c52ac92e1bbd01d613ff"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#ad69570a27f06c52ac92e1bbd01d613ff">DbcDecoder</a></td></tr>
<tr class="separator:ad69570a27f06c52ac92e1bbd01d613ff"><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>Immutable runtime snapshot. Copies share storage; reload replaces a snapshot. Owning lookup handles and decoded results keep old definitions alive. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00101">101</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#l00102">102</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="a51a44cf7c3f23c98ec8781afe0097c0c" name="a51a44cf7c3f23c98ec8781afe0097c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a44cf7c3f23c98ec8781afe0097c0c">&#9670;&#160;</a></span>DecodeDatabase()</h2>
@@ -152,7 +158,7 @@ Public Member Functions</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00111">111</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00103">103</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
</div>
</div>
@@ -173,7 +179,7 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Borrowed view, valid while this snapshot remains alive and unchanged. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00115">115</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00107">107</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="examples_2main_8cpp_source.html#l00101">main()</a>.</p>
@@ -196,9 +202,9 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Owning handles retain the entire snapshot across reload or destruction. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00120">120</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00112">112</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="decode__database_8cpp_source.html#l00146">FindSignal()</a>.</p>
<p class="reference">Referenced by <a class="el" href="decode__database_8cpp_source.html#l00138">FindSignal()</a>.</p>
</div>
</div>
@@ -219,9 +225,9 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Only explicitly marked hasPgn frames participate; ambiguous results have no definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00130">130</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00122">122</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00094">PgnLookupResult::ambiguous</a>, and <a class="el" href="decode__database_8h_source.html#l00093">PgnLookupResult::definition</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00095">PgnLookupResult::ambiguous</a>, and <a class="el" href="decode__database_8h_source.html#l00094">PgnLookupResult::definition</a>.</p>
</div>
</div>
@@ -243,9 +249,34 @@ Public Member Functions</h2></td></tr>
<p>Return an owning signal handle, or an empty handle for a missing key. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00146">146</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00138">138</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8cpp_source.html#l00120">FindFrame()</a>, <a class="el" href="definition__key_8h_source.html#l00046">SignalKey::frame</a>, <a class="el" href="decode__database_8h_source.html#l00046">DecodeSignal::name</a>, and <a class="el" href="definition__key_8h_source.html#l00047">SignalKey::name</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8cpp_source.html#l00112">FindFrame()</a>, <a class="el" href="definition__key_8h_source.html#l00046">SignalKey::frame</a>, <a class="el" href="decode__database_8h_source.html#l00047">DecodeSignal::name</a>, and <a class="el" href="definition__key_8h_source.html#l00047">SignalKey::name</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ad69570a27f06c52ac92e1bbd01d613ff" name="ad69570a27f06c52ac92e1bbd01d613ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad69570a27f06c52ac92e1bbd01d613ff">&#9670;&#160;</a></span>DbcDecoder</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classDbcDecoder.html">DbcDecoder</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00122">122</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>