235 lines
12 KiB
HTML
235 lines
12 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: DecodeDatabase Class 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('classDecodeDatabase.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="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classDecodeDatabase-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">DecodeDatabase Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Immutable runtime snapshot. Copies share storage; reload replaces a snapshot. Owning lookup handles and decoded results keep old definitions alive.
|
|
<a href="classDecodeDatabase.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="decode__database_8h_source.html">decode_database.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:a51a44cf7c3f23c98ec8781afe0097c0c" id="r_a51a44cf7c3f23c98ec8781afe0097c0c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#a51a44cf7c3f23c98ec8781afe0097c0c">DecodeDatabase</a> (const std::vector< <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > &frames)</td></tr>
|
|
<tr class="separator:a51a44cf7c3f23c98ec8781afe0097c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa034c1510984a85f60ad6c0bd744d6e8" id="r_aa034c1510984a85f60ad6c0bd744d6e8"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#aa034c1510984a85f60ad6c0bd744d6e8">GetFrames</a> () const</td></tr>
|
|
<tr class="separator:aa034c1510984a85f60ad6c0bd744d6e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a780d6e747a48b10a5eb0ab85448d2970" id="r_a780d6e747a48b10a5eb0ab85448d2970"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< const <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#a780d6e747a48b10a5eb0ab85448d2970">FindFrame</a> (const <a class="el" href="structFrameKey.html">FrameKey</a> &key) const</td></tr>
|
|
<tr class="separator:a780d6e747a48b10a5eb0ab85448d2970"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0af5b15b9953a4f6551c27ee9ae8b514" id="r_a0af5b15b9953a4f6551c27ee9ae8b514"><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="classDecodeDatabase.html#a0af5b15b9953a4f6551c27ee9ae8b514">FindSignal</a> (const <a class="el" href="structSignalKey.html">SignalKey</a> &key) const</td></tr>
|
|
<tr class="separator:a0af5b15b9953a4f6551c27ee9ae8b514"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Immutable runtime snapshot. Copies share storage; reload replaces a snapshot. Owning lookup handles and decoded results keep old definitions alive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00087">87</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a51a44cf7c3f23c98ec8781afe0097c0c" name="a51a44cf7c3f23c98ec8781afe0097c0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51a44cf7c3f23c98ec8781afe0097c0c">◆ </a></span>DecodeDatabase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DecodeDatabase::DecodeDatabase </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > & </td>
|
|
<td class="paramname"><em>frames</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Copy and validate definitions before building the frame index. Input aliases cannot modify the snapshot, even for rvalue input. </p><dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::invalid_argument</td><td>for invalid metadata or duplicate keys. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00101">101</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa034c1510984a85f60ad6c0bd744d6e8" name="aa034c1510984a85f60ad6c0bd744d6e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa034c1510984a85f60ad6c0bd744d6e8">◆ </a></span>GetFrames()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > & DecodeDatabase::GetFrames </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Borrowed view, valid while this snapshot remains alive and unchanged. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00105">105</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a780d6e747a48b10a5eb0ab85448d2970" name="a780d6e747a48b10a5eb0ab85448d2970"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a780d6e747a48b10a5eb0ab85448d2970">◆ </a></span>FindFrame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr< const <a class="el" href="structDecodeFrame.html">DecodeFrame</a> > DecodeDatabase::FindFrame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structFrameKey.html">FrameKey</a> & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Owning handles retain the entire snapshot across reload or destruction. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00110">110</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00017">DbcDecoder::FindFrame()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0af5b15b9953a4f6551c27ee9ae8b514" name="a0af5b15b9953a4f6551c27ee9ae8b514"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0af5b15b9953a4f6551c27ee9ae8b514">◆ </a></span>FindSignal()</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> > DecodeDatabase::FindSignal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structSignalKey.html">SignalKey</a> & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00120">120</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="decode__database_8h_source.html">decode_database.h</a></li>
|
|
<li><a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</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="classDecodeDatabase.html">DecodeDatabase</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>
|