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

384 lines
18 KiB
HTML
Raw Permalink 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: SignalInfo 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('structSignalInfo.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="structSignalInfo-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SignalInfo Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Describes one signal inside a DBC frame.
<a href="structSignalInfo.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="signal__info_8h_source.html">signal_info.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: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"><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="separator:ace290724f9801521609aedaa946d61f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:a1008b5201f71848177217bd52fb84baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:af363b1563fb4c7cc8973f9a80c06846c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:a52a52b320eef92fbcb4626307f9a498f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:ae4f78d99a2750aa564d7eba860171499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:ab7d0769f47aa540656b22e4e49db517e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:ada7bf94fbeaa26bd08c73982b5af255b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="separator:adf1c4331b9eabced0d7fdda40ff0eb52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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"><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: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;&nbsp;</a></span>SignalInfo()</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>
</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>
</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;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string SignalInfo::name</td>
</tr>
</table>
</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>
</div>
</div>
<a id="ace290724f9801521609aedaa946d61f1" name="ace290724f9801521609aedaa946d61f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace290724f9801521609aedaa946d61f1">&#9670;&nbsp;</a></span>startBit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t SignalInfo::startBit</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>
</div>
</div>
<a id="a1008b5201f71848177217bd52fb84baa" name="a1008b5201f71848177217bd52fb84baa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1008b5201f71848177217bd52fb84baa">&#9670;&nbsp;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t SignalInfo::length</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>
</div>
</div>
<a id="af363b1563fb4c7cc8973f9a80c06846c" name="af363b1563fb4c7cc8973f9a80c06846c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af363b1563fb4c7cc8973f9a80c06846c">&#9670;&nbsp;</a></span>isLittleEndian</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SignalInfo::isLittleEndian</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>
</div>
</div>
<a id="a52a52b320eef92fbcb4626307f9a498f" name="a52a52b320eef92fbcb4626307f9a498f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52a52b320eef92fbcb4626307f9a498f">&#9670;&nbsp;</a></span>isSigned</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SignalInfo::isSigned</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>
</div>
</div>
<a id="ae4f78d99a2750aa564d7eba860171499" name="ae4f78d99a2750aa564d7eba860171499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4f78d99a2750aa564d7eba860171499">&#9670;&nbsp;</a></span>factor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::factor</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>
</div>
</div>
<a id="ab7d0769f47aa540656b22e4e49db517e" name="ab7d0769f47aa540656b22e4e49db517e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7d0769f47aa540656b22e4e49db517e">&#9670;&nbsp;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::offset</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>
</div>
</div>
<a id="ada7bf94fbeaa26bd08c73982b5af255b" name="ada7bf94fbeaa26bd08c73982b5af255b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada7bf94fbeaa26bd08c73982b5af255b">&#9670;&nbsp;</a></span>minimum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::minimum</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>
</div>
</div>
<a id="adf1c4331b9eabced0d7fdda40ff0eb52" name="adf1c4331b9eabced0d7fdda40ff0eb52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf1c4331b9eabced0d7fdda40ff0eb52">&#9670;&nbsp;</a></span>maximum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double SignalInfo::maximum</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>
</div>
</div>
<a id="a1f214f03e94ef5794de2d3367bfcbd01" name="a1f214f03e94ef5794de2d3367bfcbd01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f214f03e94ef5794de2d3367bfcbd01">&#9670;&nbsp;</a></span>unit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string SignalInfo::unit</td>
</tr>
</table>
</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>
</div>
</div>
<a id="a2c95562fd0b29327a7fd7b1e6feee7f3" name="a2c95562fd0b29327a7fd7b1e6feee7f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c95562fd0b29327a7fd7b1e6feee7f3">&#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; SignalInfo::receivers</td>
</tr>
</table>
</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>
</div>
</div>
<a id="ac99ba7563a5dad01e39c4257216953f5" name="ac99ba7563a5dad01e39c4257216953f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac99ba7563a5dad01e39c4257216953f5">&#9670;&nbsp;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string SignalInfo::comment</td>
</tr>
</table>
</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>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="signal__info_8h_source.html">signal_info.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="structSignalInfo.html">SignalInfo</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