automotive/dbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dfec39d99684b22c0bb923bc9bbedb8034b38051
dbc/docs/html/structDecodeFrame.html

301 lines
16 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: DecodeFrame 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="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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<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="structDecodeFrame-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodeFrame Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Runtime-ready frame definition.
<a href="structDecodeFrame.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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae6ae88ee29bcaff936e7c7b2380f96b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ae6ae88ee29bcaff936e7c7b2380f96b4">DecodeFrame</a> ()</td></tr>
<tr class="separator:ae6ae88ee29bcaff936e7c7b2380f96b4"><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:aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#aa0a7f8fd5bfde2148dfd0d838328f579">name</a></td></tr>
<tr class="separator:aa0a7f8fd5bfde2148dfd0d838328f579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e10215388db7df8b541b9d9909edcf"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a52e10215388db7df8b541b9d9909edcf">canId</a></td></tr>
<tr class="separator:a52e10215388db7df8b541b9d9909edcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a3ee2348d781f8f15aaf87e8dcf57ec41">isExtended</a></td></tr>
<tr class="separator:a3ee2348d781f8f15aaf87e8dcf57ec41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51111ac13988be372d5673d12cf3e060"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a51111ac13988be372d5673d12cf3e060">dlc</a></td></tr>
<tr class="separator:a51111ac13988be372d5673d12cf3e060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3c54055c0cbceb73adf551f7067f23"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a1d3c54055c0cbceb73adf551f7067f23">pgn</a></td></tr>
<tr class="separator:a1d3c54055c0cbceb73adf551f7067f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2551102670c4a540fced4c71da0b369d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a2551102670c4a540fced4c71da0b369d">hasPgn</a></td></tr>
<tr class="separator:a2551102670c4a540fced4c71da0b369d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad78241dc40c793aabb8495b6989b81a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#ad78241dc40c793aabb8495b6989b81a9">transmitter</a></td></tr>
<tr class="separator:ad78241dc40c793aabb8495b6989b81a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25819ef907a32391af5c9f7cae9cdb22"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a25819ef907a32391af5c9f7cae9cdb22">comment</a></td></tr>
<tr class="separator:a25819ef907a32391af5c9f7cae9cdb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372afd9e74f1ae33f85cb4acfd3e2036"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structDecodeSignal.html">DecodeSignal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeFrame.html#a372afd9e74f1ae33f85cb4acfd3e2036">signals</a></td></tr>
<tr class="separator:a372afd9e74f1ae33f85cb4acfd3e2036"><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 frame definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00072">72</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="ae6ae88ee29bcaff936e7c7b2380f96b4" name="ae6ae88ee29bcaff936e7c7b2380f96b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ae88ee29bcaff936e7c7b2380f96b4">&#9670;&nbsp;</a></span>DecodeFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DecodeFrame::DecodeFrame </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#l00083">83</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="a52e10215388db7df8b541b9d9909edcf" name="a52e10215388db7df8b541b9d9909edcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e10215388db7df8b541b9d9909edcf">&#9670;&nbsp;</a></span>canId</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeFrame::canId</td>
</tr>
</table>
</div><div class="memdoc">
<p >Normalized CAN ID. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00074">74</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="a25819ef907a32391af5c9f7cae9cdb22" name="a25819ef907a32391af5c9f7cae9cdb22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25819ef907a32391af5c9f7cae9cdb22">&#9670;&nbsp;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::comment</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame comment. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00080">80</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="a51111ac13988be372d5673d12cf3e060" name="a51111ac13988be372d5673d12cf3e060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51111ac13988be372d5673d12cf3e060">&#9670;&nbsp;</a></span>dlc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t DecodeFrame::dlc</td>
</tr>
</table>
</div><div class="memdoc">
<p >Payload length. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00076">76</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="a2551102670c4a540fced4c71da0b369d" name="a2551102670c4a540fced4c71da0b369d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2551102670c4a540fced4c71da0b369d">&#9670;&nbsp;</a></span>hasPgn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeFrame::hasPgn</td>
</tr>
</table>
</div><div class="memdoc">
<p >true if PGN is valid. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00078">78</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="a3ee2348d781f8f15aaf87e8dcf57ec41" name="a3ee2348d781f8f15aaf87e8dcf57ec41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee2348d781f8f15aaf87e8dcf57ec41">&#9670;&nbsp;</a></span>isExtended</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeFrame::isExtended</td>
</tr>
</table>
</div><div class="memdoc">
<p >true for extended frame. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00075">75</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="aa0a7f8fd5bfde2148dfd0d838328f579" name="aa0a7f8fd5bfde2148dfd0d838328f579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0a7f8fd5bfde2148dfd0d838328f579">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::name</td>
</tr>
</table>
</div><div class="memdoc">
<p >Frame name. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00073">73</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>, and <a class="el" href="main_8cpp_source.html#l00075">PrintDecodedFrame()</a>.</p>
</div>
</div>
<a id="a1d3c54055c0cbceb73adf551f7067f23" name="a1d3c54055c0cbceb73adf551f7067f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3c54055c0cbceb73adf551f7067f23">&#9670;&nbsp;</a></span>pgn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t DecodeFrame::pgn</td>
</tr>
</table>
</div><div class="memdoc">
<p >PGN if available. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00077">77</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="a372afd9e74f1ae33f85cb4acfd3e2036" name="a372afd9e74f1ae33f85cb4acfd3e2036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a372afd9e74f1ae33f85cb4acfd3e2036">&#9670;&nbsp;</a></span>signals</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structDecodeSignal.html">DecodeSignal</a>&gt; DecodeFrame::signals</td>
</tr>
</table>
</div><div class="memdoc">
<p >Signal definitions. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00081">81</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>, and <a class="el" href="dbc__decoder_8cpp_source.html#l00031">DbcDecoder::Decode()</a>.</p>
</div>
</div>
<a id="ad78241dc40c793aabb8495b6989b81a9" name="ad78241dc40c793aabb8495b6989b81a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad78241dc40c793aabb8495b6989b81a9">&#9670;&nbsp;</a></span>transmitter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DecodeFrame::transmitter</td>
</tr>
</table>
</div><div class="memdoc">
<p >Transmitter ECU. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00079">79</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>
<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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 14 2026 20:49:34 for DBC framework by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink