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/structFrameInfo.html
+82 -11
View File
@@ -122,11 +122,17 @@ Public Attributes</h2></td></tr>
<tr class="separator:ace75121294f9d89b762080ab5643293c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7e25d67ddae22f2ed50823a5a26084" id="r_a3f7e25d67ddae22f2ed50823a5a26084"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structSignalInfo.html">SignalInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a3f7e25d67ddae22f2ed50823a5a26084">public</a></td></tr>
<tr class="separator:a3f7e25d67ddae22f2ed50823a5a26084"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35bf839519ef3f48b5f52dd9bcd7e9ac" id="r_a35bf839519ef3f48b5f52dd9bcd7e9ac"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a35bf839519ef3f48b5f52dd9bcd7e9ac">frameFormat</a></td></tr>
<tr class="separator:a35bf839519ef3f48b5f52dd9bcd7e9ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a099f02a77adfb9ac23e286ce75f4eef4" id="r_a099f02a77adfb9ac23e286ce75f4eef4"><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="structFrameInfo.html#a099f02a77adfb9ac23e286ce75f4eef4">cycleTimeMs</a></td></tr>
<tr class="separator:a099f02a77adfb9ac23e286ce75f4eef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ef2736053b593cf34ba2608cf8275c0" id="r_a9ef2736053b593cf34ba2608cf8275c0"><td class="memItemLeft" align="right" valign="top">AttributeMap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a9ef2736053b593cf34ba2608cf8275c0">attributes</a></td></tr>
<tr class="separator:a9ef2736053b593cf34ba2608cf8275c0"><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>Describes one CAN frame from a DBC file. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00024">24</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00025">25</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="abb53a7f93ed7abc0ea1ae4a8ccafcdcb" name="abb53a7f93ed7abc0ea1ae4a8ccafcdcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">&#9670;&#160;</a></span>name</h2>
@@ -141,7 +147,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Frame name. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00025">25</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00026">26</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__statement__handler_8cpp_source.html#l00292">DbcSignalHandler::Handle()</a>.</p>
</div>
</div>
@@ -158,7 +166,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Normalized CAN identifier. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00026">26</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00027">27</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>.</p>
</div>
</div>
@@ -175,7 +185,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="frame__info_8h_source.html#l00027">27</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00028">28</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00278">DbcFrameHandler::Handle()</a>.</p>
</div>
</div>
@@ -192,7 +204,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>J1939 PGN if applicable. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00028">28</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00029">29</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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>
@@ -207,9 +221,11 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>true if PGN was derived. </p>
<p>Explicit J1939 opt-in; pgn is derived from canId. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00029">29</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00030">30</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.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>
@@ -226,7 +242,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Frame payload length. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00030">30</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00031">31</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00292">DbcSignalHandler::Handle()</a>.</p>
</div>
</div>
@@ -243,7 +261,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Transmitter ECU name. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00031">31</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00032">32</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
@@ -260,7 +278,9 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Optional frame comment. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00032">32</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00033">33</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>, and <a class="el" href="dbc__statement__handler_8cpp_source.html#l00352">DbcParseContext::ResolveComments()</a>.</p>
</div>
</div>
@@ -277,7 +297,58 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Signals contained in the frame. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00033">33</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00034">34</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
<a id="a35bf839519ef3f48b5f52dd9bcd7e9ac" name="a35bf839519ef3f48b5f52dd9bcd7e9ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35bf839519ef3f48b5f52dd9bcd7e9ac">&#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; FrameInfo::frameFormat</td>
</tr>
</table>
</div><div class="memdoc">
<p>VFrameFormat label, when declared. VFrameFormat enum label. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00036">36</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
<a id="a099f02a77adfb9ac23e286ce75f4eef4" name="a099f02a77adfb9ac23e286ce75f4eef4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a099f02a77adfb9ac23e286ce75f4eef4">&#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; FrameInfo::cycleTimeMs</td>
</tr>
</table>
</div><div class="memdoc">
<p>GenMsgCycleTime in milliseconds, when declared. GenMsgCycleTime; zero means unspecified. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00037">37</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
<a id="a9ef2736053b593cf34ba2608cf8275c0" name="a9ef2736053b593cf34ba2608cf8275c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ef2736053b593cf34ba2608cf8275c0">&#9670;&#160;</a></span>attributes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AttributeMap FrameInfo::attributes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Effective attributes after defaults and overrides. Effective values, including defaults. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00039">39</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>