upfate doxygen

2026-10-20 13:40:44 -04:00
1 parent a55d1c58ed
commit c43222939f
@@ -0,0 +1,282 @@
+<!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: AttributeDefinition 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('structAttributeDefinition.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-attribs">Public Attributes</a> &#124;
+<a href="structAttributeDefinition-members.html">List of all members</a>  </div>
+  <div class="headertitle"><div class="title">AttributeDefinition Struct Reference</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>Attribute type, permitted range, and optional default.  
+ <a href="structAttributeDefinition.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="attributes_8h_source.html">attributes.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:a5f109f0ec94eb04c3f52c116366aefdf" id="r_a5f109f0ec94eb04c3f52c116366aefdf"><td class="memItemLeft" align="right" valign="top">AttributeScope&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#a5f109f0ec94eb04c3f52c116366aefdf">scope</a> = AttributeScope::Database</td></tr>
+<tr class="separator:a5f109f0ec94eb04c3f52c116366aefdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5de5484174a8c5f6b309041089d20afc" id="r_a5de5484174a8c5f6b309041089d20afc"><td class="memItemLeft" align="right" valign="top">AttributeType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#a5de5484174a8c5f6b309041089d20afc">type</a> = AttributeType::String</td></tr>
+<tr class="separator:a5de5484174a8c5f6b309041089d20afc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aaf87153bac0b228ad87b88e96f303210" id="r_aaf87153bac0b228ad87b88e96f303210"><td class="memItemLeft" align="right" valign="top">std::int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#aaf87153bac0b228ad87b88e96f303210">integerMinimum</a> = 0</td></tr>
+<tr class="separator:aaf87153bac0b228ad87b88e96f303210"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5ca8f41ea3e921f54d81b8760c1dcfb3" id="r_a5ca8f41ea3e921f54d81b8760c1dcfb3"><td class="memItemLeft" align="right" valign="top">std::int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#a5ca8f41ea3e921f54d81b8760c1dcfb3">integerMaximum</a> = 0</td></tr>
+<tr class="separator:a5ca8f41ea3e921f54d81b8760c1dcfb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a18245dba995929a61fd6de1fcdbc8a89" id="r_a18245dba995929a61fd6de1fcdbc8a89"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#a18245dba995929a61fd6de1fcdbc8a89">minimum</a> = 0.0</td></tr>
+<tr class="separator:a18245dba995929a61fd6de1fcdbc8a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa02fe74b5420c2e67c13e610b6bc9713" id="r_aa02fe74b5420c2e67c13e610b6bc9713"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#aa02fe74b5420c2e67c13e610b6bc9713">maximum</a> = 0.0</td></tr>
+<tr class="separator:aa02fe74b5420c2e67c13e610b6bc9713"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a547fe17f6cfc631528f9156e4a509c66" id="r_a547fe17f6cfc631528f9156e4a509c66"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#a547fe17f6cfc631528f9156e4a509c66">enumValues</a></td></tr>
+<tr class="separator:a547fe17f6cfc631528f9156e4a509c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae0949edf67f9d4e60e4cb376a95da4f2" id="r_ae0949edf67f9d4e60e4cb376a95da4f2"><td class="memItemLeft" align="right" valign="top">std::optional&lt; AttributeValue &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAttributeDefinition.html#ae0949edf67f9d4e60e4cb376a95da4f2">defaultValue</a></td></tr>
+<tr class="separator:ae0949edf67f9d4e60e4cb376a95da4f2"><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>Attribute type, permitted range, and optional default. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00042">42</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+</div><h2 class="groupheader">Member Data Documentation</h2>
+<a id="a5f109f0ec94eb04c3f52c116366aefdf" name="a5f109f0ec94eb04c3f52c116366aefdf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5f109f0ec94eb04c3f52c116366aefdf">&#9670;&#160;</a></span>scope</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">AttributeScope AttributeDefinition::scope = AttributeScope::Database</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Target scope; database when no scope marker is present. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00043">43</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="dbc__attributes_8cpp_source.html#l00255">DbcParseContext::ResolveAttributes()</a>.</p>
+
+</div>
+</div>
+<a id="a5de5484174a8c5f6b309041089d20afc" name="a5de5484174a8c5f6b309041089d20afc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5de5484174a8c5f6b309041089d20afc">&#9670;&#160;</a></span>type</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">AttributeType AttributeDefinition::type = AttributeType::String</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Type used to validate values. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00044">44</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="aaf87153bac0b228ad87b88e96f303210" name="aaf87153bac0b228ad87b88e96f303210"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaf87153bac0b228ad87b88e96f303210">&#9670;&#160;</a></span>integerMinimum</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::int64_t AttributeDefinition::integerMinimum = 0</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Inclusive INT, HEX, or ENUM lower bound. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00045">45</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="a5ca8f41ea3e921f54d81b8760c1dcfb3" name="a5ca8f41ea3e921f54d81b8760c1dcfb3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5ca8f41ea3e921f54d81b8760c1dcfb3">&#9670;&#160;</a></span>integerMaximum</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::int64_t AttributeDefinition::integerMaximum = 0</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Inclusive INT, HEX, or ENUM upper bound. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00046">46</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="a18245dba995929a61fd6de1fcdbc8a89" name="a18245dba995929a61fd6de1fcdbc8a89"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a18245dba995929a61fd6de1fcdbc8a89">&#9670;&#160;</a></span>minimum</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">double AttributeDefinition::minimum = 0.0</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Inclusive FLOAT lower bound. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00047">47</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="aa02fe74b5420c2e67c13e610b6bc9713" name="aa02fe74b5420c2e67c13e610b6bc9713"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa02fe74b5420c2e67c13e610b6bc9713">&#9670;&#160;</a></span>maximum</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">double AttributeDefinition::maximum = 0.0</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Inclusive FLOAT upper bound. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00048">48</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="a547fe17f6cfc631528f9156e4a509c66" name="a547fe17f6cfc631528f9156e4a509c66"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a547fe17f6cfc631528f9156e4a509c66">&#9670;&#160;</a></span>enumValues</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::vector&lt;std::string&gt; AttributeDefinition::enumValues</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>ENUM labels in index order. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00049">49</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+</div>
+</div>
+<a id="ae0949edf67f9d4e60e4cb376a95da4f2" name="ae0949edf67f9d4e60e4cb376a95da4f2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae0949edf67f9d4e60e4cb376a95da4f2">&#9670;&#160;</a></span>defaultValue</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::optional&lt;AttributeValue&gt; AttributeDefinition::defaultValue</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Validated default; empty when not declared. </p>
+
+<p class="definition">Definition at line <a class="el" href="attributes_8h_source.html#l00050">50</a> of file <a class="el" href="attributes_8h_source.html">attributes.h</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="dbc__attributes_8cpp_source.html#l00255">DbcParseContext::ResolveAttributes()</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="attributes_8h_source.html">attributes.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="structAttributeDefinition.html">AttributeDefinition</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>