upfate doxygen

This commit is contained in:
deeaitch committed 2026-10-20 13:40:44 -04:00
1 parent a55d1c58ed
commit c43222939f
433 files changed
+15617 -7061

No files matched your search

+182
View File
@@ -0,0 +1,182 @@
<!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: attributes.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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('attributes_8h_source.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="headertitle"><div class="title">attributes.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#ifndef DBC_ATTRIBUTES_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#define DBC_ATTRIBUTES_H</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;variant&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">enum class</span> AttributeScope {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> Database,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> Node,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> Frame,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> Signal,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> Environment</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>};</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">enum class</span> AttributeType {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> Integer,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> Hex,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> Float,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> String,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> Enum</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>};</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">using </span>AttributeValue = std::variant&lt;std::int64_t, double, std::string&gt;;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">using </span>AttributeMap = std::map&lt;std::string, AttributeValue&gt;;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="foldopen" id="foldopen00042" data-start="{" data-end="};">
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html"> 42</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structAttributeDefinition.html">AttributeDefinition</a> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#a5f109f0ec94eb04c3f52c116366aefdf"> 43</a></span> AttributeScope <a class="code hl_variable" href="structAttributeDefinition.html#a5f109f0ec94eb04c3f52c116366aefdf">scope</a> = AttributeScope::Database; </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#a5de5484174a8c5f6b309041089d20afc"> 44</a></span> AttributeType <a class="code hl_variable" href="structAttributeDefinition.html#a5de5484174a8c5f6b309041089d20afc">type</a> = AttributeType::String; </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#aaf87153bac0b228ad87b88e96f303210"> 45</a></span> std::int64_t <a class="code hl_variable" href="structAttributeDefinition.html#aaf87153bac0b228ad87b88e96f303210">integerMinimum</a> = 0; </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#a5ca8f41ea3e921f54d81b8760c1dcfb3"> 46</a></span> std::int64_t <a class="code hl_variable" href="structAttributeDefinition.html#a5ca8f41ea3e921f54d81b8760c1dcfb3">integerMaximum</a> = 0; </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#a18245dba995929a61fd6de1fcdbc8a89"> 47</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structAttributeDefinition.html#a18245dba995929a61fd6de1fcdbc8a89">minimum</a> = 0.0; </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#aa02fe74b5420c2e67c13e610b6bc9713"> 48</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structAttributeDefinition.html#aa02fe74b5420c2e67c13e610b6bc9713">maximum</a> = 0.0; </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#a547fe17f6cfc631528f9156e4a509c66"> 49</a></span> std::vector&lt;std::string&gt; <a class="code hl_variable" href="structAttributeDefinition.html#a547fe17f6cfc631528f9156e4a509c66">enumValues</a>; </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structAttributeDefinition.html#ae0949edf67f9d4e60e4cb376a95da4f2"> 50</a></span> std::optional&lt;AttributeValue&gt; <a class="code hl_variable" href="structAttributeDefinition.html#ae0949edf67f9d4e60e4cb376a95da4f2">defaultValue</a>; </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="};">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html"> 59</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structAttributeAssignment.html">AttributeAssignment</a> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#aa8707eddd2d3a2de559fe44354a514cc"> 60</a></span> std::string <a class="code hl_variable" href="structAttributeAssignment.html#aa8707eddd2d3a2de559fe44354a514cc">name</a>; </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#a50405e8db9e4536015f9adc5ba360270"> 61</a></span> AttributeScope <a class="code hl_variable" href="structAttributeAssignment.html#a50405e8db9e4536015f9adc5ba360270">scope</a> = AttributeScope::Database; </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#a330ae1a34c342b0352115a83dd31aab8"> 62</a></span> std::uint32_t <a class="code hl_variable" href="structAttributeAssignment.html#a330ae1a34c342b0352115a83dd31aab8">canId</a> = 0U; </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#a024a249cc63dbfbf337eea395fe3471e"> 63</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structAttributeAssignment.html#a024a249cc63dbfbf337eea395fe3471e">isExtended</a> = <span class="keyword">false</span>; </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#a50059e42e5e5b944050f3290ce84ac66"> 64</a></span> std::string <a class="code hl_variable" href="structAttributeAssignment.html#a50059e42e5e5b944050f3290ce84ac66">targetName</a>; </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structAttributeAssignment.html#a93de8c51c5154219bf18beadcec5708f"> 65</a></span> AttributeValue <a class="code hl_variable" href="structAttributeAssignment.html#a93de8c51c5154219bf18beadcec5708f">value</a>; </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>};</div>
</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="astructAttributeAssignment_html"><div class="ttname"><a href="structAttributeAssignment.html">AttributeAssignment</a></div><div class="ttdoc">Explicit assignment; defaults remain on definitions.</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00059">attributes.h:59</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_a024a249cc63dbfbf337eea395fe3471e"><div class="ttname"><a href="structAttributeAssignment.html#a024a249cc63dbfbf337eea395fe3471e">AttributeAssignment::isExtended</a></div><div class="ttdeci">bool isExtended</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00063">attributes.h:63</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_a330ae1a34c342b0352115a83dd31aab8"><div class="ttname"><a href="structAttributeAssignment.html#a330ae1a34c342b0352115a83dd31aab8">AttributeAssignment::canId</a></div><div class="ttdeci">std::uint32_t canId</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00062">attributes.h:62</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_a50059e42e5e5b944050f3290ce84ac66"><div class="ttname"><a href="structAttributeAssignment.html#a50059e42e5e5b944050f3290ce84ac66">AttributeAssignment::targetName</a></div><div class="ttdeci">std::string targetName</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00064">attributes.h:64</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_a50405e8db9e4536015f9adc5ba360270"><div class="ttname"><a href="structAttributeAssignment.html#a50405e8db9e4536015f9adc5ba360270">AttributeAssignment::scope</a></div><div class="ttdeci">AttributeScope scope</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00061">attributes.h:61</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_a93de8c51c5154219bf18beadcec5708f"><div class="ttname"><a href="structAttributeAssignment.html#a93de8c51c5154219bf18beadcec5708f">AttributeAssignment::value</a></div><div class="ttdeci">AttributeValue value</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00065">attributes.h:65</a></div></div>
<div class="ttc" id="astructAttributeAssignment_html_aa8707eddd2d3a2de559fe44354a514cc"><div class="ttname"><a href="structAttributeAssignment.html#aa8707eddd2d3a2de559fe44354a514cc">AttributeAssignment::name</a></div><div class="ttdeci">std::string name</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00060">attributes.h:60</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html"><div class="ttname"><a href="structAttributeDefinition.html">AttributeDefinition</a></div><div class="ttdoc">Attribute type, permitted range, and optional default.</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00042">attributes.h:42</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_a18245dba995929a61fd6de1fcdbc8a89"><div class="ttname"><a href="structAttributeDefinition.html#a18245dba995929a61fd6de1fcdbc8a89">AttributeDefinition::minimum</a></div><div class="ttdeci">double minimum</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00047">attributes.h:47</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_a547fe17f6cfc631528f9156e4a509c66"><div class="ttname"><a href="structAttributeDefinition.html#a547fe17f6cfc631528f9156e4a509c66">AttributeDefinition::enumValues</a></div><div class="ttdeci">std::vector&lt; std::string &gt; enumValues</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00049">attributes.h:49</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_a5ca8f41ea3e921f54d81b8760c1dcfb3"><div class="ttname"><a href="structAttributeDefinition.html#a5ca8f41ea3e921f54d81b8760c1dcfb3">AttributeDefinition::integerMaximum</a></div><div class="ttdeci">std::int64_t integerMaximum</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00046">attributes.h:46</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_a5de5484174a8c5f6b309041089d20afc"><div class="ttname"><a href="structAttributeDefinition.html#a5de5484174a8c5f6b309041089d20afc">AttributeDefinition::type</a></div><div class="ttdeci">AttributeType type</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00044">attributes.h:44</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_a5f109f0ec94eb04c3f52c116366aefdf"><div class="ttname"><a href="structAttributeDefinition.html#a5f109f0ec94eb04c3f52c116366aefdf">AttributeDefinition::scope</a></div><div class="ttdeci">AttributeScope scope</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00043">attributes.h:43</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_aa02fe74b5420c2e67c13e610b6bc9713"><div class="ttname"><a href="structAttributeDefinition.html#aa02fe74b5420c2e67c13e610b6bc9713">AttributeDefinition::maximum</a></div><div class="ttdeci">double maximum</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00048">attributes.h:48</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_aaf87153bac0b228ad87b88e96f303210"><div class="ttname"><a href="structAttributeDefinition.html#aaf87153bac0b228ad87b88e96f303210">AttributeDefinition::integerMinimum</a></div><div class="ttdeci">std::int64_t integerMinimum</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00045">attributes.h:45</a></div></div>
<div class="ttc" id="astructAttributeDefinition_html_ae0949edf67f9d4e60e4cb376a95da4f2"><div class="ttname"><a href="structAttributeDefinition.html#ae0949edf67f9d4e60e4cb376a95da4f2">AttributeDefinition::defaultValue</a></div><div class="ttdeci">std::optional&lt; AttributeValue &gt; defaultValue</div><div class="ttdef"><b>Definition</b> <a href="attributes_8h_source.html#l00050">attributes.h:50</a></div></div>
</div><!-- fragment --></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="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><b>attributes.h</b></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>