Generated foxygen documentation. Closes #1

This commit is contained in:
2026-06-14 20:51:56 -04:00
parent e2c07dde0d
commit dfec39d996
164 changed files with 25311 additions and 0 deletions

View File

@@ -0,0 +1,195 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DBC framework: DecodedSignalValue Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">DBC framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<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>
</div><!--header-->
<div class="contents">
<p>One decoded signal value.
<a href="structDecodedSignalValue.html#details">More...</a></p>
<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:a1481b122a7ce5a618012b1133c6adedf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a1481b122a7ce5a618012b1133c6adedf">DecodedSignalValue</a> ()</td></tr>
<tr class="separator:a1481b122a7ce5a618012b1133c6adedf"><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"><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="separator:acadc3b3bb21dd6b0412d342c7e6b20d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5138b825940e34689f7b3891627ee9ec"><td class="memItemLeft" align="right" valign="top">std::int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a5138b825940e34689f7b3891627ee9ec">rawValue</a></td></tr>
<tr class="separator:a5138b825940e34689f7b3891627ee9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:a6847d05b3cb00d5e0f6c611968f57978"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:aac0ed361af545cde48d0e6f41a859686"><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#l00038">38</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;&nbsp;</a></span>DecodedSignalValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DecodedSignalValue::DecodedSignalValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="dbc__decoder_8h_source.html#l00044">44</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acadc3b3bb21dd6b0412d342c7e6b20d7" name="acadc3b3bb21dd6b0412d342c7e6b20d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acadc3b3bb21dd6b0412d342c7e6b20d7">&#9670;&nbsp;</a></span>definition</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structDecodeSignal.html">DecodeSignal</a>* DecodedSignalValue::definition</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#l00039">39</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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
</div>
</div>
<a id="a6847d05b3cb00d5e0f6c611968f57978" name="a6847d05b3cb00d5e0f6c611968f57978"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6847d05b3cb00d5e0f6c611968f57978">&#9670;&nbsp;</a></span>physicalValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodedSignalValue::physicalValue</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#l00041">41</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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
</div>
</div>
<a id="a5138b825940e34689f7b3891627ee9ec" name="a5138b825940e34689f7b3891627ee9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5138b825940e34689f7b3891627ee9ec">&#9670;&nbsp;</a></span>rawValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::int64_t DecodedSignalValue::rawValue</td>
</tr>
</table>
</div><div class="memdoc">
<p >Extracted raw integer 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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
</div>
</div>
<a id="aac0ed361af545cde48d0e6f41a859686" name="aac0ed361af545cde48d0e6f41a859686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac0ed361af545cde48d0e6f41a859686">&#9670;&nbsp;</a></span>valid</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodedSignalValue::valid</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#l00042">42</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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 14 2026 20:49:34 for DBC framework by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>