Files
dbc/docs/html/structSignalKey.html
2026-10-11 06:30:18 -04:00

236 lines
11 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: SignalKey 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&amp;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&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('structSignalKey.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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structSignalKey-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SignalKey Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="definition__key_8h_source.html">definition_key.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:aa4221b34e75469bf5aa939976c334f46" id="r_aa4221b34e75469bf5aa939976c334f46"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalKey.html#aa4221b34e75469bf5aa939976c334f46">SignalKey</a> (<a class="el" href="structFrameKey.html">FrameKey</a> frameKey, std::string signalName)</td></tr>
<tr class="separator:aa4221b34e75469bf5aa939976c334f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17525dc0116be7f4f58f3c3fae1022e2" id="r_a17525dc0116be7f4f58f3c3fae1022e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalKey.html#a17525dc0116be7f4f58f3c3fae1022e2">operator==</a> (const <a class="el" href="structSignalKey.html">SignalKey</a> &amp;other) const</td></tr>
<tr class="separator:a17525dc0116be7f4f58f3c3fae1022e2"><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:a25f4ece1bf685791b576f68e23d8ccc7" id="r_a25f4ece1bf685791b576f68e23d8ccc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFrameKey.html">FrameKey</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalKey.html#a25f4ece1bf685791b576f68e23d8ccc7">frame</a></td></tr>
<tr class="separator:a25f4ece1bf685791b576f68e23d8ccc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abab371cce740f05111fd3b4013ca6944" id="r_abab371cce740f05111fd3b4013ca6944"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSignalKey.html#abab371cce740f05111fd3b4013ca6944">name</a></td></tr>
<tr class="separator:abab371cce740f05111fd3b4013ca6944"><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>Stable signal identifier within one logical DBC database. </p>
<p class="definition">Definition at line <a class="el" href="definition__key_8h_source.html#l00042">42</a> of file <a class="el" href="definition__key_8h_source.html">definition_key.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa4221b34e75469bf5aa939976c334f46" name="aa4221b34e75469bf5aa939976c334f46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4221b34e75469bf5aa939976c334f46">&#9670;&#160;</a></span>SignalKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SignalKey::SignalKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFrameKey.html">FrameKey</a>&#160;</td>
<td class="paramname"><em>frameKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>signalName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="definition__key_8h_source.html#l00047">47</a> of file <a class="el" href="definition__key_8h_source.html">definition_key.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a17525dc0116be7f4f58f3c3fae1022e2" name="a17525dc0116be7f4f58f3c3fae1022e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17525dc0116be7f4f58f3c3fae1022e2">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool SignalKey::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structSignalKey.html">SignalKey</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></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 class="definition">Definition at line <a class="el" href="definition__key_8h_source.html#l00051">51</a> of file <a class="el" href="definition__key_8h_source.html">definition_key.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a25f4ece1bf685791b576f68e23d8ccc7" name="a25f4ece1bf685791b576f68e23d8ccc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25f4ece1bf685791b576f68e23d8ccc7">&#9670;&#160;</a></span>frame</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structFrameKey.html">FrameKey</a> SignalKey::frame</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="definition__key_8h_source.html#l00043">43</a> of file <a class="el" href="definition__key_8h_source.html">definition_key.h</a>.</p>
</div>
</div>
<a id="abab371cce740f05111fd3b4013ca6944" name="abab371cce740f05111fd3b4013ca6944"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abab371cce740f05111fd3b4013ca6944">&#9670;&#160;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string SignalKey::name</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="definition__key_8h_source.html#l00044">44</a> of file <a class="el" href="definition__key_8h_source.html">definition_key.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="definition__key_8h_source.html">definition_key.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="structSignalKey.html">SignalKey</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>