285 lines
15 KiB
HTML
285 lines
15 KiB
HTML
<!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" lang="en-US">
|
|
<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.8"/>
|
|
<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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.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>
|
|
<div id="projectbrief">DBC parsing and CAN signal decoding framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structDecodedSignalValue.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<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 <<a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>></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 * </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"> </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:a828b5ef7faefc14fbf5dbd46249bcad2" id="r_a828b5ef7faefc14fbf5dbd46249bcad2"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< const <a class="el" href="structDecodeSignal.html">DecodeSignal</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a828b5ef7faefc14fbf5dbd46249bcad2">definition</a></td></tr>
|
|
<tr class="separator:a828b5ef7faefc14fbf5dbd46249bcad2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33df0fcd92b23b3e08539906fc6b4c4a" id="r_a33df0fcd92b23b3e08539906fc6b4c4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSignalKey.html">SignalKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodedSignalValue.html#a33df0fcd92b23b3e08539906fc6b4c4a">key</a></td></tr>
|
|
<tr class="separator:a33df0fcd92b23b3e08539906fc6b4c4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a503c90b4b1a610b8252c45e466367c28" id="r_a503c90b4b1a610b8252c45e466367c28"><td class="memItemLeft" align="right" valign="top">RawSignalValue </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"> </td></tr>
|
|
<tr class="memitem:a6847d05b3cb00d5e0f6c611968f57978" id="r_a6847d05b3cb00d5e0f6c611968f57978"><td class="memItemLeft" align="right" valign="top">double </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"> </td></tr>
|
|
<tr class="memitem:aac0ed361af545cde48d0e6f41a859686" id="r_aac0ed361af545cde48d0e6f41a859686"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
|
|
<tr class="memitem:a94161a80412b3961da8fd2fec43c25f6" id="r_a94161a80412b3961da8fd2fec43c25f6"><td class="memItemLeft" align="right" valign="top">SignalDecodeStatus </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"> </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#l00052">52</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">◆ </a></span>GetValueDescription()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string * DecodedSignalValue::GetValueDescription </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</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>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#l00061">61</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#l00053">definition</a>, <a class="el" href="dbc__decoder_8h_source.html#l00055">rawValue</a>, and <a class="el" href="dbc__decoder_8h_source.html#l00057">valid</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a828b5ef7faefc14fbf5dbd46249bcad2" name="a828b5ef7faefc14fbf5dbd46249bcad2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a828b5ef7faefc14fbf5dbd46249bcad2">◆ </a></span>definition</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<const <a class="el" href="structDecodeSignal.html">DecodeSignal</a>> DecodedSignalValue::definition</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Owning immutable definition. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00053">53</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#l00023">DbcDecoder::Decode()</a>, and <a class="el" href="dbc__decoder_8h_source.html#l00061">GetValueDescription()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33df0fcd92b23b3e08539906fc6b4c4a" name="a33df0fcd92b23b3e08539906fc6b4c4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33df0fcd92b23b3e08539906fc6b4c4a">◆ </a></span>key</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structSignalKey.html">SignalKey</a> DecodedSignalValue::key</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Stable application identifier. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00054">54</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#l00023">DbcDecoder::Decode()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a503c90b4b1a610b8252c45e466367c28" name="a503c90b4b1a610b8252c45e466367c28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a503c90b4b1a610b8252c45e466367c28">◆ </a></span>rawValue</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RawSignalValue DecodedSignalValue::rawValue = std::uint64_t(0U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Exact raw value for Valid or PhysicalConversionFailed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00055">55</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_8h_source.html#l00061">GetValueDescription()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6847d05b3cb00d5e0f6c611968f57978" name="a6847d05b3cb00d5e0f6c611968f57978"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6847d05b3cb00d5e0f6c611968f57978">◆ </a></span>physicalValue</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double DecodedSignalValue::physicalValue = 0.0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Conversion result, possibly NaN/Inf on failure. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00056">56</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac0ed361af545cde48d0e6f41a859686" name="aac0ed361af545cde48d0e6f41a859686"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac0ed361af545cde48d0e6f41a859686">◆ </a></span>valid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<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#l00057">57</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#l00023">DbcDecoder::Decode()</a>, and <a class="el" href="dbc__decoder_8h_source.html#l00061">GetValueDescription()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94161a80412b3961da8fd2fec43c25f6" name="a94161a80412b3961da8fd2fec43c25f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94161a80412b3961da8fd2fec43c25f6">◆ </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#l00058">58</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</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 -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structDecodedSignalValue.html">DecodedSignalValue</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|