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/structDbcParseContext.html
+161 -8
View File
@@ -103,8 +103,16 @@ $(document).ready(function(){initNavTree('structDbcParseContext.html',''); initR
<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="memdesc:a908056de0a97316a4ebecb3f99cc400b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validate selectors, branch ranges, and signal overlap. <br /></td></tr>
<tr class="separator:a908056de0a97316a4ebecb3f99cc400b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeae343c57a244634489a0e0b960155d7" id="r_aeae343c57a244634489a0e0b960155d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#aeae343c57a244634489a0e0b960155d7">ResolveComments</a> (const std::string &amp;filePath)</td></tr>
<tr class="memdesc:aeae343c57a244634489a0e0b960155d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve deferred comments after all definitions are known. <br /></td></tr>
<tr class="separator:aeae343c57a244634489a0e0b960155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ac7f4a54550aaddef08749806f87001" id="r_a1ac7f4a54550aaddef08749806f87001"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a1ac7f4a54550aaddef08749806f87001">ResolveAttributes</a> (const std::string &amp;filePath, std::vector&lt; <a class="el" href="structDbcDiagnostic.html">DbcDiagnostic</a> &gt; &amp;diagnostics)</td></tr>
<tr class="memdesc:a1ac7f4a54550aaddef08749806f87001"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve definitions, defaults, then assignments; append format warnings. <br /></td></tr>
<tr class="separator:a1ac7f4a54550aaddef08749806f87001"><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="memdesc:ab5552dad944fde7fa6add6464ddb5369"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve deferred raw descriptions against unique targets. <br /></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>
@@ -113,17 +121,23 @@ Public Attributes</h2></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:a93f8ece0f3d16bd79f631ae07afa7b54" id="r_a93f8ece0f3d16bd79f631ae07afa7b54"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a93f8ece0f3d16bd79f631ae07afa7b54">enableJ1939</a> = false</td></tr>
<tr class="separator:a93f8ece0f3d16bd79f631ae07afa7b54"><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>
<tr class="memitem:a854abba7bbf4adfc948554c254156e60" id="r_a854abba7bbf4adfc948554c254156e60"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structPendingComment.html">PendingComment</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#a854abba7bbf4adfc948554c254156e60">pendingComments</a> = {}</td></tr>
<tr class="separator:a854abba7bbf4adfc948554c254156e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbfa4b26a58b41ada3dabc619066035c" id="r_afbfa4b26a58b41ada3dabc619066035c"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structPendingAttribute.html">PendingAttribute</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDbcParseContext.html#afbfa4b26a58b41ada3dabc619066035c">pendingAttributes</a> = {}</td></tr>
<tr class="separator:afbfa4b26a58b41ada3dabc619066035c"><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#l00032">32</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#l00050">50</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>
@@ -141,7 +155,69 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00510">510</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
<p>Validate selectors, branch ranges, and signal overlap. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00512">512</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__statement__handler_8h_source.html#l00051">database</a>, <a class="el" href="dbc__database_8h_source.html#l00023">DbcDatabase::frames</a>, and <a class="el" href="dbc__statement__handler_8h_source.html#l00057">signalLines</a>.</p>
</div>
</div>
<a id="aeae343c57a244634489a0e0b960155d7" name="aeae343c57a244634489a0e0b960155d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeae343c57a244634489a0e0b960155d7">&#9670;&#160;</a></span>ResolveComments()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DbcParseContext::ResolveComments </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>Resolve deferred comments after all definitions are known. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00352">352</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
<p class="reference">References <a class="el" href="frame__info_8h_source.html#l00033">FrameInfo::comment</a>, <a class="el" href="signal__info_8h_source.html#l00039">SignalInfo::comment</a>, <a class="el" href="dbc__statement__handler_8h_source.html#l00051">database</a>, and <a class="el" href="dbc__statement__handler_8h_source.html#l00061">pendingComments</a>.</p>
</div>
</div>
<a id="a1ac7f4a54550aaddef08749806f87001" name="a1ac7f4a54550aaddef08749806f87001"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ac7f4a54550aaddef08749806f87001">&#9670;&#160;</a></span>ResolveAttributes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DbcParseContext::ResolveAttributes </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="structDbcDiagnostic.html">DbcDiagnostic</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>diagnostics</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve definitions, defaults, then assignments; append format warnings. </p>
<p class="definition">Definition at line <a class="el" href="dbc__attributes_8cpp_source.html#l00255">255</a> of file <a class="el" href="dbc__attributes_8cpp_source.html">dbc_attributes.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__database_8h_source.html#l00025">DbcDatabase::attributeAssignments</a>, <a class="el" href="dbc__database_8h_source.html#l00024">DbcDatabase::attributeDefinitions</a>, <a class="el" href="attributes_8h_source.html#l00062">AttributeAssignment::canId</a>, <a class="el" href="dbc__statement__handler_8h_source.html#l00051">database</a>, <a class="el" href="attributes_8h_source.html#l00050">AttributeDefinition::defaultValue</a>, <a class="el" href="dbc__database_8h_source.html#l00023">DbcDatabase::frames</a>, <a class="el" href="attributes_8h_source.html#l00063">AttributeAssignment::isExtended</a>, <a class="el" href="attributes_8h_source.html#l00060">AttributeAssignment::name</a>, <a class="el" href="dbc__statement__handler_8h_source.html#l00065">pendingAttributes</a>, <a class="el" href="attributes_8h_source.html#l00043">AttributeDefinition::scope</a>, <a class="el" href="attributes_8h_source.html#l00061">AttributeAssignment::scope</a>, <a class="el" href="attributes_8h_source.html#l00064">AttributeAssignment::targetName</a>, and <a class="el" href="attributes_8h_source.html#l00065">AttributeAssignment::value</a>.</p>
</div>
</div>
@@ -161,7 +237,11 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00433">433</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
<p>Resolve deferred raw descriptions against unique targets. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8cpp_source.html#l00435">435</a> of file <a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__statement__handler_8h_source.html#l00051">database</a>, <a class="el" href="dbc__statement__handler_8h_source.html#l00055">pendingValues</a>, and <a class="el" href="signal__info_8h_source.html#l00038">SignalInfo::valueDescriptions</a>.</p>
</div>
</div>
@@ -177,8 +257,11 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parsed metadata under construction. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00033">33</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#l00051">51</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>, <a class="el" href="dbc__attributes_8cpp_source.html#l00255">ResolveAttributes()</a>, <a class="el" href="dbc__statement__handler_8cpp_source.html#l00352">ResolveComments()</a>, <a class="el" href="dbc__statement__handler_8cpp_source.html#l00435">ResolveValueDescriptions()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00512">ValidateMultiplexing()</a>.</p>
</div>
</div>
@@ -193,8 +276,30 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Current frame for following signal definitions. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00034">34</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#l00052">52</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00292">DbcSignalHandler::Handle()</a>.</p>
</div>
</div>
<a id="a93f8ece0f3d16bd79f631ae07afa7b54" name="a93f8ece0f3d16bd79f631ae07afa7b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93f8ece0f3d16bd79f631ae07afa7b54">&#9670;&#160;</a></span>enableJ1939</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DbcParseContext::enableJ1939 = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Explicit interpretation option for extended frames. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00053">53</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>.</p>
</div>
</div>
@@ -209,8 +314,11 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Physical line of the current statement. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00035">35</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#l00054">54</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00292">DbcSignalHandler::Handle()</a>, <a class="el" href="dbc__statement__handler_8cpp_source.html#l00306">DbcCommentHandler::Handle()</a>, <a class="el" href="dbc__attributes_8cpp_source.html#l00251">DbcAttributeHandler::Handle()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00402">DbcValueDescriptionHandler::Handle()</a>.</p>
</div>
</div>
@@ -225,8 +333,11 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Unresolved raw value descriptions. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00036">36</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#l00055">55</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00402">DbcValueDescriptionHandler::Handle()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00435">ResolveValueDescriptions()</a>.</p>
</div>
</div>
@@ -241,13 +352,55 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Signal definition lines grouped by frame. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00038">38</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#l00057">57</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>, <a class="el" href="dbc__statement__handler_8cpp_source.html#l00292">DbcSignalHandler::Handle()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00512">ValidateMultiplexing()</a>.</p>
</div>
</div>
<a id="a854abba7bbf4adfc948554c254156e60" name="a854abba7bbf4adfc948554c254156e60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a854abba7bbf4adfc948554c254156e60">&#9670;&#160;</a></span>pendingComments</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structPendingComment.html">PendingComment</a>&gt; DbcParseContext::pendingComments = {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unresolved comments in source order. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00061">61</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00306">DbcCommentHandler::Handle()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00352">ResolveComments()</a>.</p>
</div>
</div>
<a id="afbfa4b26a58b41ada3dabc619066035c" name="afbfa4b26a58b41ada3dabc619066035c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbfa4b26a58b41ada3dabc619066035c">&#9670;&#160;</a></span>pendingAttributes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structPendingAttribute.html">PendingAttribute</a>&gt; DbcParseContext::pendingAttributes = {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unresolved attributes in source order. </p>
<p class="definition">Definition at line <a class="el" href="dbc__statement__handler_8h_source.html#l00065">65</a> of file <a class="el" href="dbc__statement__handler_8h_source.html">dbc_statement_handler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__attributes_8cpp_source.html#l00251">DbcAttributeHandler::Handle()</a>, and <a class="el" href="dbc__attributes_8cpp_source.html#l00255">ResolveAttributes()</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__attributes_8cpp_source.html">dbc_attributes.cpp</a></li>
<li><a class="el" href="dbc__statement__handler_8cpp_source.html">dbc_statement_handler.cpp</a></li>
</ul>
</div><!-- contents -->