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/structSignalInfo.html
+54 -69
View File
@@ -104,64 +104,56 @@ $(document).ready(function(){initNavTree('structSignalInfo.html',''); initResiza
<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:a8a2e29f307c75926a1bd824266d23ca8" id="r_a8a2e29f307c75926a1bd824266d23ca8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMultiplexing.html">Multiplexing</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a8a2e29f307c75926a1bd824266d23ca8">multiplexing</a></td></tr>
<tr class="separator:a8a2e29f307c75926a1bd824266d23ca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a379e422a00cad56f896cacf60455b088" id="r_a379e422a00cad56f896cacf60455b088"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a379e422a00cad56f896cacf60455b088">name</a></td></tr>
<tr class="separator:a379e422a00cad56f896cacf60455b088"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace290724f9801521609aedaa946d61f1" id="r_ace290724f9801521609aedaa946d61f1"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ace290724f9801521609aedaa946d61f1">startBit</a></td></tr>
<tr class="memitem:ace290724f9801521609aedaa946d61f1" id="r_ace290724f9801521609aedaa946d61f1"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ace290724f9801521609aedaa946d61f1">startBit</a> = 0U</td></tr>
<tr class="separator:ace290724f9801521609aedaa946d61f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1008b5201f71848177217bd52fb84baa" id="r_a1008b5201f71848177217bd52fb84baa"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a1008b5201f71848177217bd52fb84baa">length</a></td></tr>
<tr class="memitem:a1008b5201f71848177217bd52fb84baa" id="r_a1008b5201f71848177217bd52fb84baa"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a1008b5201f71848177217bd52fb84baa">length</a> = 0U</td></tr>
<tr class="separator:a1008b5201f71848177217bd52fb84baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af363b1563fb4c7cc8973f9a80c06846c" id="r_af363b1563fb4c7cc8973f9a80c06846c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#af363b1563fb4c7cc8973f9a80c06846c">isLittleEndian</a></td></tr>
<tr class="memitem:af363b1563fb4c7cc8973f9a80c06846c" id="r_af363b1563fb4c7cc8973f9a80c06846c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#af363b1563fb4c7cc8973f9a80c06846c">isLittleEndian</a> = true</td></tr>
<tr class="separator:af363b1563fb4c7cc8973f9a80c06846c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52a52b320eef92fbcb4626307f9a498f" id="r_a52a52b320eef92fbcb4626307f9a498f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a52a52b320eef92fbcb4626307f9a498f">isSigned</a></td></tr>
<tr class="memitem:a52a52b320eef92fbcb4626307f9a498f" id="r_a52a52b320eef92fbcb4626307f9a498f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a52a52b320eef92fbcb4626307f9a498f">isSigned</a> = false</td></tr>
<tr class="separator:a52a52b320eef92fbcb4626307f9a498f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4f78d99a2750aa564d7eba860171499" id="r_ae4f78d99a2750aa564d7eba860171499"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ae4f78d99a2750aa564d7eba860171499">factor</a></td></tr>
<tr class="memitem:ae4f78d99a2750aa564d7eba860171499" id="r_ae4f78d99a2750aa564d7eba860171499"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ae4f78d99a2750aa564d7eba860171499">factor</a> = 1.0</td></tr>
<tr class="separator:ae4f78d99a2750aa564d7eba860171499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7d0769f47aa540656b22e4e49db517e" id="r_ab7d0769f47aa540656b22e4e49db517e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ab7d0769f47aa540656b22e4e49db517e">offset</a></td></tr>
<tr class="memitem:ab7d0769f47aa540656b22e4e49db517e" id="r_ab7d0769f47aa540656b22e4e49db517e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ab7d0769f47aa540656b22e4e49db517e">offset</a> = 0.0</td></tr>
<tr class="separator:ab7d0769f47aa540656b22e4e49db517e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada7bf94fbeaa26bd08c73982b5af255b" id="r_ada7bf94fbeaa26bd08c73982b5af255b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ada7bf94fbeaa26bd08c73982b5af255b">minimum</a></td></tr>
<tr class="memitem:ada7bf94fbeaa26bd08c73982b5af255b" id="r_ada7bf94fbeaa26bd08c73982b5af255b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ada7bf94fbeaa26bd08c73982b5af255b">minimum</a> = 0.0</td></tr>
<tr class="separator:ada7bf94fbeaa26bd08c73982b5af255b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf1c4331b9eabced0d7fdda40ff0eb52" id="r_adf1c4331b9eabced0d7fdda40ff0eb52"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#adf1c4331b9eabced0d7fdda40ff0eb52">maximum</a></td></tr>
<tr class="memitem:adf1c4331b9eabced0d7fdda40ff0eb52" id="r_adf1c4331b9eabced0d7fdda40ff0eb52"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#adf1c4331b9eabced0d7fdda40ff0eb52">maximum</a> = 0.0</td></tr>
<tr class="separator:adf1c4331b9eabced0d7fdda40ff0eb52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f214f03e94ef5794de2d3367bfcbd01" id="r_a1f214f03e94ef5794de2d3367bfcbd01"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a1f214f03e94ef5794de2d3367bfcbd01">unit</a></td></tr>
<tr class="separator:a1f214f03e94ef5794de2d3367bfcbd01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c95562fd0b29327a7fd7b1e6feee7f3" id="r_a2c95562fd0b29327a7fd7b1e6feee7f3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a2c95562fd0b29327a7fd7b1e6feee7f3">receivers</a></td></tr>
<tr class="separator:a2c95562fd0b29327a7fd7b1e6feee7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43f47d0433d0cc39076bd7278b46af9c" id="r_a43f47d0433d0cc39076bd7278b46af9c"><td class="memItemLeft" align="right" valign="top">ValueDescriptions&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#a43f47d0433d0cc39076bd7278b46af9c">valueDescriptions</a></td></tr>
<tr class="separator:a43f47d0433d0cc39076bd7278b46af9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac99ba7563a5dad01e39c4257216953f5" id="r_ac99ba7563a5dad01e39c4257216953f5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalInfo.html#ac99ba7563a5dad01e39c4257216953f5">comment</a></td></tr>
<tr class="separator:ac99ba7563a5dad01e39c4257216953f5"><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 signal inside a DBC frame. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00022">22</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa2d2cd238118015258e271dce92a971e" name="aa2d2cd238118015258e271dce92a971e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2d2cd238118015258e271dce92a971e">&#9670;&#160;</a></span>SignalInfo()</h2>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00024">24</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a8a2e29f307c75926a1bd824266d23ca8" name="a8a2e29f307c75926a1bd824266d23ca8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a2e29f307c75926a1bd824266d23ca8">&#9670;&#160;</a></span>multiplexing</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SignalInfo::SignalInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
<td class="memname"><a class="el" href="structMultiplexing.html">Multiplexing</a> SignalInfo::multiplexing</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00036">36</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00025">25</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a379e422a00cad56f896cacf60455b088" name="a379e422a00cad56f896cacf60455b088"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a379e422a00cad56f896cacf60455b088">&#9670;&#160;</a></span>name</h2>
@@ -175,9 +167,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Signal name. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00023">23</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00026">26</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -188,15 +178,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t SignalInfo::startBit</td>
<td class="memname">std::uint32_t SignalInfo::startBit = 0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Start bit in DBC notation. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00024">24</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00027">27</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -207,15 +195,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t SignalInfo::length</td>
<td class="memname">std::uint32_t SignalInfo::length = 0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal length in bits. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00025">25</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00028">28</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -226,15 +212,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SignalInfo::isLittleEndian</td>
<td class="memname">bool SignalInfo::isLittleEndian = true</td>
</tr>
</table>
</div><div class="memdoc">
<p>true for Intel, false for Motorola. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00026">26</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00029">29</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -245,15 +229,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SignalInfo::isSigned</td>
<td class="memname">bool SignalInfo::isSigned = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if signal is signed. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00027">27</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00030">30</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -264,15 +246,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::factor</td>
<td class="memname">double SignalInfo::factor = 1.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Scaling factor. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00028">28</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00031">31</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -283,15 +263,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::offset</td>
<td class="memname">double SignalInfo::offset = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Physical offset. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00029">29</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00032">32</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -302,15 +280,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::minimum</td>
<td class="memname">double SignalInfo::minimum = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum physical value. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00030">30</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00033">33</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -321,15 +297,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::maximum</td>
<td class="memname">double SignalInfo::maximum = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum physical value. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00031">31</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00034">34</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -346,9 +320,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Physical unit. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00032">32</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00035">35</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -365,9 +337,24 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Signal receivers. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00033">33</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00036">36</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a43f47d0433d0cc39076bd7278b46af9c" name="a43f47d0433d0cc39076bd7278b46af9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43f47d0433d0cc39076bd7278b46af9c">&#9670;&#160;</a></span>valueDescriptions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ValueDescriptions SignalInfo::valueDescriptions</td>
</tr>
</table>
</div><div class="memdoc">
<p>Raw integer state descriptions. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00037">37</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>
@@ -384,9 +371,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Optional signal comment. </p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00034">34</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
<p class="definition">Definition at line <a class="el" href="signal__info_8h_source.html#l00038">38</a> of file <a class="el" href="signal__info_8h_source.html">signal_info.h</a>.</p>
</div>
</div>