automotive/dbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
38ce043ae083fccd352d4ea3c75c690bd4ef77b8
dbc/docs/html/structDecodeSignal.html
deeaitch 38ce043ae0 updated documentation
2026-06-14 21:05:20 -04:00

386 lines
19 KiB
HTML
Raw Blame History

<!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: DecodeSignal 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.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structDecodeSignal.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structDecodeSignal-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodeSignal Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Runtime-ready signal definition.
<a href="structDecodeSignal.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="decode__database_8h_source.html">decode_database.h</a>&gt;</code></p>
<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:a58cf5844f2272a23dcb9687d912e4780"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a58cf5844f2272a23dcb9687d912e4780">name</a></td></tr>
<tr class="separator:a58cf5844f2272a23dcb9687d912e4780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf5d7527ddf65b6355c2b4f3626df22d"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#aaf5d7527ddf65b6355c2b4f3626df22d">startBit</a></td></tr>
<tr class="separator:aaf5d7527ddf65b6355c2b4f3626df22d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd4ef5ee30421d117b5756854302debb"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#acd4ef5ee30421d117b5756854302debb">length</a></td></tr>
<tr class="separator:acd4ef5ee30421d117b5756854302debb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdc4c4bb4a67a6d61d6ca81e8a52833d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#abdc4c4bb4a67a6d61d6ca81e8a52833d">byteOrder</a></td></tr>
<tr class="separator:abdc4c4bb4a67a6d61d6ca81e8a52833d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d37638129263b8902ba5be59baf39a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="decode__database_8h.html#ad9971b6ef33e02ba2c75d19c1d2518a1">ValueType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a9d37638129263b8902ba5be59baf39a8">valueType</a></td></tr>
<tr class="separator:a9d37638129263b8902ba5be59baf39a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a428c39913a366a8476dd291061354391"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a428c39913a366a8476dd291061354391">factor</a></td></tr>
<tr class="separator:a428c39913a366a8476dd291061354391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92db637af4e224a0ae70173050dc3f74"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a92db637af4e224a0ae70173050dc3f74">offset</a></td></tr>
<tr class="separator:a92db637af4e224a0ae70173050dc3f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fb84e19a0ab3bd50b6f65c1075ebc25"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a0fb84e19a0ab3bd50b6f65c1075ebc25">minimum</a></td></tr>
<tr class="separator:a0fb84e19a0ab3bd50b6f65c1075ebc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a6ba87142a9badbf0ca830e9e709cb7"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a4a6ba87142a9badbf0ca830e9e709cb7">maximum</a></td></tr>
<tr class="separator:a4a6ba87142a9badbf0ca830e9e709cb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38eed9ca7581423fd8bfbedcffc12092"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#a38eed9ca7581423fd8bfbedcffc12092">unit</a></td></tr>
<tr class="separator:a38eed9ca7581423fd8bfbedcffc12092"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdbae62a64d2df716bf60c6b67b30eaa"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#abdbae62a64d2df716bf60c6b67b30eaa">receivers</a></td></tr>
<tr class="separator:abdbae62a64d2df716bf60c6b67b30eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae28c905d4a2bc86419c2a8361bfea473"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeSignal.html#ae28c905d4a2bc86419c2a8361bfea473">comment</a></td></tr>
<tr class="separator:ae28c905d4a2bc86419c2a8361bfea473"><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 >Runtime-ready signal definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00039">39</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a93fd97267e2614979440261628e493f5" name="a93fd97267e2614979440261628e493f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93fd97267e2614979440261628e493f5">&#9670;&nbsp;</a></span>DecodeSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DecodeSignal::DecodeSignal </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="decode__database_8h_source.html#l00053">53</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a58cf5844f2272a23dcb9687d912e4780" name="a58cf5844f2272a23dcb9687d912e4780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58cf5844f2272a23dcb9687d912e4780">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeSignal::name</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signal name. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00040">40</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.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="aaf5d7527ddf65b6355c2b4f3626df22d" name="aaf5d7527ddf65b6355c2b4f3626df22d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf5d7527ddf65b6355c2b4f3626df22d">&#9670;&nbsp;</a></span>startBit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeSignal::startBit</td>
</tr>
</table>
</div><div class="memdoc">
<p >DBC start bit. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00041">41</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.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="acd4ef5ee30421d117b5756854302debb" name="acd4ef5ee30421d117b5756854302debb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd4ef5ee30421d117b5756854302debb">&#9670;&nbsp;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeSignal::length</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signal length in bits. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00042">42</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.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="abdc4c4bb4a67a6d61d6ca81e8a52833d" name="abdc4c4bb4a67a6d61d6ca81e8a52833d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdc4c4bb4a67a6d61d6ca81e8a52833d">&#9670;&nbsp;</a></span>byteOrder</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> DecodeSignal::byteOrder</td>
</tr>
</table>
</div><div class="memdoc">
<p >Intel or Motorola. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00043">43</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.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="a9d37638129263b8902ba5be59baf39a8" name="a9d37638129263b8902ba5be59baf39a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d37638129263b8902ba5be59baf39a8">&#9670;&nbsp;</a></span>valueType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="decode__database_8h.html#ad9971b6ef33e02ba2c75d19c1d2518a1">ValueType</a> DecodeSignal::valueType</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signed or unsigned. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00044">44</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
</div>
</div>
<a id="a428c39913a366a8476dd291061354391" name="a428c39913a366a8476dd291061354391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a428c39913a366a8476dd291061354391">&#9670;&nbsp;</a></span>factor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodeSignal::factor</td>
</tr>
</table>
</div><div class="memdoc">
<p >Scaling factor. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00045">45</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="a92db637af4e224a0ae70173050dc3f74" name="a92db637af4e224a0ae70173050dc3f74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92db637af4e224a0ae70173050dc3f74">&#9670;&nbsp;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodeSignal::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p >Physical offset. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00046">46</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="a0fb84e19a0ab3bd50b6f65c1075ebc25" name="a0fb84e19a0ab3bd50b6f65c1075ebc25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fb84e19a0ab3bd50b6f65c1075ebc25">&#9670;&nbsp;</a></span>minimum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodeSignal::minimum</td>
</tr>
</table>
</div><div class="memdoc">
<p >Minimum physical value. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00047">47</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="a4a6ba87142a9badbf0ca830e9e709cb7" name="a4a6ba87142a9badbf0ca830e9e709cb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a6ba87142a9badbf0ca830e9e709cb7">&#9670;&nbsp;</a></span>maximum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DecodeSignal::maximum</td>
</tr>
</table>
</div><div class="memdoc">
<p >Maximum physical value. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00048">48</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="a38eed9ca7581423fd8bfbedcffc12092" name="a38eed9ca7581423fd8bfbedcffc12092"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38eed9ca7581423fd8bfbedcffc12092">&#9670;&nbsp;</a></span>unit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeSignal::unit</td>
</tr>
</table>
</div><div class="memdoc">
<p >Physical unit. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00049">49</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="abdbae62a64d2df716bf60c6b67b30eaa" name="abdbae62a64d2df716bf60c6b67b30eaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdbae62a64d2df716bf60c6b67b30eaa">&#9670;&nbsp;</a></span>receivers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::string&gt; DecodeSignal::receivers</td>
</tr>
</table>
</div><div class="memdoc">
<p >Receivers. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00050">50</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<a id="ae28c905d4a2bc86419c2a8361bfea473" name="ae28c905d4a2bc86419c2a8361bfea473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28c905d4a2bc86419c2a8361bfea473">&#9670;&nbsp;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeSignal::comment</td>
</tr>
</table>
</div><div class="memdoc">
<p >Comment. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00051">51</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="decode__database_8h_source.html">decode_database.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="structDecodeSignal.html">DecodeSignal</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.4 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink