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/structDecodedSignalValue.html
+52 -27
View File
@@ -91,6 +91,7 @@ $(document).ready(function(){initNavTree('structDecodedSignalValue.html',''); in
<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="structDecodedSignalValue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodedSignalValue Struct Reference</div></div>
@@ -102,24 +103,31 @@ $(document).ready(function(){initNavTree('structDecodedSignalValue.html',''); in
<p><code>#include &lt;<a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.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:affc38af1bf31bcb6f2c33044bce92bd2" id="r_affc38af1bf31bcb6f2c33044bce92bd2"><td class="memItemLeft" align="right" valign="top">const std::string *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#affc38af1bf31bcb6f2c33044bce92bd2">GetValueDescription</a> () const</td></tr>
<tr class="separator:affc38af1bf31bcb6f2c33044bce92bd2"><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:acadc3b3bb21dd6b0412d342c7e6b20d7" id="r_acadc3b3bb21dd6b0412d342c7e6b20d7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structDecodeSignal.html">DecodeSignal</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#acadc3b3bb21dd6b0412d342c7e6b20d7">definition</a></td></tr>
<tr class="memitem:acadc3b3bb21dd6b0412d342c7e6b20d7" id="r_acadc3b3bb21dd6b0412d342c7e6b20d7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structDecodeSignal.html">DecodeSignal</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#acadc3b3bb21dd6b0412d342c7e6b20d7">definition</a> = nullptr</td></tr>
<tr class="separator:acadc3b3bb21dd6b0412d342c7e6b20d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95db4f7f93b5f311e8f272833e45055e" id="r_a95db4f7f93b5f311e8f272833e45055e"><td class="memItemLeft" align="right" valign="top">std::variant&lt; std::int64_t, std::uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a95db4f7f93b5f311e8f272833e45055e">rawValue</a></td></tr>
<tr class="separator:a95db4f7f93b5f311e8f272833e45055e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6847d05b3cb00d5e0f6c611968f57978" id="r_a6847d05b3cb00d5e0f6c611968f57978"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a6847d05b3cb00d5e0f6c611968f57978">physicalValue</a></td></tr>
<tr class="memitem:a503c90b4b1a610b8252c45e466367c28" id="r_a503c90b4b1a610b8252c45e466367c28"><td class="memItemLeft" align="right" valign="top">RawSignalValue&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a503c90b4b1a610b8252c45e466367c28">rawValue</a> = std::uint64_t(0U)</td></tr>
<tr class="separator:a503c90b4b1a610b8252c45e466367c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6847d05b3cb00d5e0f6c611968f57978" id="r_a6847d05b3cb00d5e0f6c611968f57978"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a6847d05b3cb00d5e0f6c611968f57978">physicalValue</a> = 0.0</td></tr>
<tr class="separator:a6847d05b3cb00d5e0f6c611968f57978"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac0ed361af545cde48d0e6f41a859686" id="r_aac0ed361af545cde48d0e6f41a859686"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#aac0ed361af545cde48d0e6f41a859686">valid</a></td></tr>
<tr class="memitem:aac0ed361af545cde48d0e6f41a859686" id="r_aac0ed361af545cde48d0e6f41a859686"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#aac0ed361af545cde48d0e6f41a859686">valid</a> = false</td></tr>
<tr class="separator:aac0ed361af545cde48d0e6f41a859686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94161a80412b3961da8fd2fec43c25f6" id="r_a94161a80412b3961da8fd2fec43c25f6"><td class="memItemLeft" align="right" valign="top">SignalDecodeStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a94161a80412b3961da8fd2fec43c25f6">status</a> = SignalDecodeStatus::InvalidDefinition</td></tr>
<tr class="separator:a94161a80412b3961da8fd2fec43c25f6"><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>One decoded signal value. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00037">37</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1481b122a7ce5a618012b1133c6adedf" name="a1481b122a7ce5a618012b1133c6adedf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1481b122a7ce5a618012b1133c6adedf">&#9670;&#160;</a></span>DecodedSignalValue()</h2>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00043">43</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="affc38af1bf31bcb6f2c33044bce92bd2" name="affc38af1bf31bcb6f2c33044bce92bd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affc38af1bf31bcb6f2c33044bce92bd2">&#9670;&#160;</a></span>GetValueDescription()</h2>
<div class="memitem">
<div class="memproto">
@@ -128,10 +136,10 @@ Public Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DecodedSignalValue::DecodedSignalValue </td>
<td class="memname">const std::string * DecodedSignalValue::GetValueDescription </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
<td> const</td>
</tr>
</table>
</td>
@@ -140,8 +148,11 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Lookup using the raw integer; nullptr for invalid or unmapped values. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00043">43</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00051">51</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">References <a class="el" href="dbc__decoder_8h_source.html#l00044">definition</a>, <a class="el" href="dbc__decoder_8h_source.html#l00045">rawValue</a>, <a class="el" href="dbc__decoder_8h_source.html#l00047">valid</a>, and <a class="el" href="decode__database_8h_source.html#l00054">DecodeSignal::valueDescriptions</a>.</p>
</div>
</div>
@@ -153,34 +164,34 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structDecodeSignal.html">DecodeSignal</a>* DecodedSignalValue::definition</td>
<td class="memname">const <a class="el" href="structDecodeSignal.html">DecodeSignal</a>* DecodedSignalValue::definition = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal definition. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00038">38</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00044">44</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8h_source.html#l00051">GetValueDescription()</a>.</p>
</div>
</div>
<a id="a95db4f7f93b5f311e8f272833e45055e" name="a95db4f7f93b5f311e8f272833e45055e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95db4f7f93b5f311e8f272833e45055e">&#9670;&#160;</a></span>rawValue</h2>
<a id="a503c90b4b1a610b8252c45e466367c28" name="a503c90b4b1a610b8252c45e466367c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503c90b4b1a610b8252c45e466367c28">&#9670;&#160;</a></span>rawValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::variant&lt;std::int64_t, std::uint64_t&gt; DecodedSignalValue::rawValue</td>
<td class="memname">RawSignalValue DecodedSignalValue::rawValue = std::uint64_t(0U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Exact signed or unsigned raw value. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00039">39</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00045">45</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8h_source.html#l00051">GetValueDescription()</a>.</p>
</div>
</div>
@@ -191,15 +202,13 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodedSignalValue::physicalValue</td>
<td class="memname">double DecodedSignalValue::physicalValue = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converted physical value. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00040">40</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00046">46</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div>
</div>
@@ -210,15 +219,31 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodedSignalValue::valid</td>
<td class="memname">bool DecodedSignalValue::valid = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if decoding succeeded. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00041">41</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00047">47</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8h_source.html#l00051">GetValueDescription()</a>.</p>
</div>
</div>
<a id="a94161a80412b3961da8fd2fec43c25f6" name="a94161a80412b3961da8fd2fec43c25f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94161a80412b3961da8fd2fec43c25f6">&#9670;&#160;</a></span>status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SignalDecodeStatus DecodedSignalValue::status = SignalDecodeStatus::InvalidDefinition</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00048">48</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div>
</div>