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/structDbcParseContext.html
+109 -5
View File
@@ -91,6 +91,7 @@ $(document).ready(function(){initNavTree('structDbcParseContext.html',''); initR
<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="structDbcParseContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DbcParseContext Struct Reference</div></div>
@@ -99,18 +100,72 @@ $(document).ready(function(){initNavTree('structDbcParseContext.html',''); initR
<p><code>#include &lt;<a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.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:a908056de0a97316a4ebecb3f99cc400b" id="r_a908056de0a97316a4ebecb3f99cc400b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a908056de0a97316a4ebecb3f99cc400b">ValidateMultiplexing</a> (const std::string &amp;filePath) const</td></tr>
<tr class="separator:a908056de0a97316a4ebecb3f99cc400b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5552dad944fde7fa6add6464ddb5369" id="r_ab5552dad944fde7fa6add6464ddb5369"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#ab5552dad944fde7fa6add6464ddb5369">ResolveValueDescriptions</a> (const std::string &amp;filePath)</td></tr>
<tr class="separator:ab5552dad944fde7fa6add6464ddb5369"><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:a79bad0b8302e2156670461bab529259c" id="r_a79bad0b8302e2156670461bab529259c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDbcDatabase.html">DbcDatabase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a79bad0b8302e2156670461bab529259c">database</a></td></tr>
<tr class="separator:a79bad0b8302e2156670461bab529259c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31b56247edff7f025957ae023a56913" id="r_af31b56247edff7f025957ae023a56913"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFrameInfo.html">FrameInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#af31b56247edff7f025957ae023a56913">currentFrame</a> = nullptr</td></tr>
<tr class="separator:af31b56247edff7f025957ae023a56913"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f5a7f613ecd0dadbafa7af736b7e54" id="r_a57f5a7f613ecd0dadbafa7af736b7e54"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a57f5a7f613ecd0dadbafa7af736b7e54">lineNumber</a> = 0U</td></tr>
<tr class="separator:a57f5a7f613ecd0dadbafa7af736b7e54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22cba614ada3a28c7dcc1ea338b0e01" id="r_ac22cba614ada3a28c7dcc1ea338b0e01"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structPendingValueDescriptions.html">PendingValueDescriptions</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#ac22cba614ada3a28c7dcc1ea338b0e01">pendingValues</a> = {}</td></tr>
<tr class="separator:ac22cba614ada3a28c7dcc1ea338b0e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8b411c938a2ea9100c4aaae452e6546" id="r_af8b411c938a2ea9100c4aaae452e6546"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; std::size_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#af8b411c938a2ea9100c4aaae452e6546">signalLines</a> = {}</td></tr>
<tr class="separator:af8b411c938a2ea9100c4aaae452e6546"><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>Mutable state belonging to one file parse. Handlers do not retain it. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00011">11</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00019">19</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a908056de0a97316a4ebecb3f99cc400b" name="a908056de0a97316a4ebecb3f99cc400b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a908056de0a97316a4ebecb3f99cc400b">&#9670;&#160;</a></span>ValidateMultiplexing()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DbcParseContext::ValidateMultiplexing </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filePath</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00502">502</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
</div>
</div>
<a id="ab5552dad944fde7fa6add6464ddb5369" name="ab5552dad944fde7fa6add6464ddb5369"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5552dad944fde7fa6add6464ddb5369">&#9670;&#160;</a></span>ResolveValueDescriptions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DbcParseContext::ResolveValueDescriptions </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filePath</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00427">427</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a79bad0b8302e2156670461bab529259c" name="a79bad0b8302e2156670461bab529259c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79bad0b8302e2156670461bab529259c">&#9670;&#160;</a></span>database</h2>
@@ -123,7 +178,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00012">12</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00020">20</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div>
</div>
@@ -139,12 +194,61 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00013">13</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00021">21</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<a id="a57f5a7f613ecd0dadbafa7af736b7e54" name="a57f5a7f613ecd0dadbafa7af736b7e54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57f5a7f613ecd0dadbafa7af736b7e54">&#9670;&#160;</a></span>lineNumber</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t DbcParseContext::lineNumber = 0U</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00022">22</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div>
</div>
<a id="ac22cba614ada3a28c7dcc1ea338b0e01" name="ac22cba614ada3a28c7dcc1ea338b0e01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac22cba614ada3a28c7dcc1ea338b0e01">&#9670;&#160;</a></span>pendingValues</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structPendingValueDescriptions.html">PendingValueDescriptions</a>&gt; DbcParseContext::pendingValues = {}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00023">23</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div>
</div>
<a id="af8b411c938a2ea9100c4aaae452e6546" name="af8b411c938a2ea9100c4aaae452e6546"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8b411c938a2ea9100c4aaae452e6546">&#9670;&#160;</a></span>signalLines</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;std::size_t&gt; &gt; DbcParseContext::signalLines = {}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00025">25</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a></li>
<li><a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->