automotive/dbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Generated foxygen documentation. Closes #1

Browse Source
This commit is contained in:
deeaitch
2026-06-14 20:51:56 -04:00
parent e2c07dde0d
commit dfec39d996
164 changed files with 25311 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
docs/latex/decode__database_8h.tex Normal file
View File

@@ -0,0 +1,95 @@
\hypertarget{decode__database_8h}{}\doxysection{decode\+\_\+database.\+h File Reference}
\label{decode__database_8h}\index{decode\_database.h@{decode\_database.h}}
Created\+: 2026-\/03-\/13 Author\+: Deeaitch (Dim. Himro)
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
{\ttfamily \#include $<$cstdint$>$}\newline
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structDecodeSignal}{Decode\+Signal}}
\begin{DoxyCompactList}\small\item\em Runtime-\/ready signal definition. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structDecodeFrame}{Decode\+Frame}}
\begin{DoxyCompactList}\small\item\em Runtime-\/ready frame definition. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structFrameKey}{Frame\+Key}}
\begin{DoxyCompactList}\small\item\em Key for fast frame lookup. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structFrameKeyHasher}{Frame\+Key\+Hasher}}
\begin{DoxyCompactList}\small\item\em Hasher for frame key. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structDecodeDatabase}{Decode\+Database}}
\begin{DoxyCompactList}\small\item\em Runtime decode database with fast lookup by CAN ID. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}{Byte\+Order}} \{ \mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142baff97a9fdede09eaf6e1c8ec9f6a61dd5}{Intel}}
, \mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142ba2ed1afe3c9215523e4272f46e6186b31}{Motorola}}
\}
\begin{DoxyCompactList}\small\item\em Signal byte order used for runtime decoding. \end{DoxyCompactList}\item
enum class \mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}{Value\+Type}} \{ \mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1aa1a914735b205424ba6c40b85528d78a}{Unsigned}}
, \mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1a71fed0c3428bf1a2e19af257c4bac379}{Signed}}
\}
\begin{DoxyCompactList}\small\item\em Signal numeric type. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Created\+: 2026-\/03-\/13 Author\+: Deeaitch (Dim. Himro)
Licensed under the MIT License. See LICENSE file in the project root for full license text.
Definition in file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\doxysubsection{Enumeration Type Documentation}
\mbox{\Hypertarget{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}\label{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}}
\index{decode\_database.h@{decode\_database.h}!ByteOrder@{ByteOrder}}
\index{ByteOrder@{ByteOrder}!decode\_database.h@{decode\_database.h}}
\doxysubsubsection{\texorpdfstring{ByteOrder}{ByteOrder}}
{\footnotesize\ttfamily enum class \mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}{Byte\+Order}}\hspace{0.3cm}{\ttfamily [strong]}}
Signal byte order used for runtime decoding.
\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Intel@{Intel}!decode\_database.h@{decode\_database.h}}\index{decode\_database.h@{decode\_database.h}!Intel@{Intel}}}\mbox{\Hypertarget{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142baff97a9fdede09eaf6e1c8ec9f6a61dd5}\label{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142baff97a9fdede09eaf6e1c8ec9f6a61dd5}}
Intel&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{Motorola@{Motorola}!decode\_database.h@{decode\_database.h}}\index{decode\_database.h@{decode\_database.h}!Motorola@{Motorola}}}\mbox{\Hypertarget{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142ba2ed1afe3c9215523e4272f46e6186b31}\label{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142ba2ed1afe3c9215523e4272f46e6186b31}}
Motorola&\\
\hline
\end{DoxyEnumFields}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00023}{23}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\mbox{\Hypertarget{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}\label{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}}
\index{decode\_database.h@{decode\_database.h}!ValueType@{ValueType}}
\index{ValueType@{ValueType}!decode\_database.h@{decode\_database.h}}
\doxysubsubsection{\texorpdfstring{ValueType}{ValueType}}
{\footnotesize\ttfamily enum class \mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}{Value\+Type}}\hspace{0.3cm}{\ttfamily [strong]}}
Signal numeric type.
\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Unsigned@{Unsigned}!decode\_database.h@{decode\_database.h}}\index{decode\_database.h@{decode\_database.h}!Unsigned@{Unsigned}}}\mbox{\Hypertarget{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1aa1a914735b205424ba6c40b85528d78a}\label{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1aa1a914735b205424ba6c40b85528d78a}}
Unsigned&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{Signed@{Signed}!decode\_database.h@{decode\_database.h}}\index{decode\_database.h@{decode\_database.h}!Signed@{Signed}}}\mbox{\Hypertarget{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1a71fed0c3428bf1a2e19af257c4bac379}\label{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1a71fed0c3428bf1a2e19af257c4bac379}}
Signed&\\
\hline
\end{DoxyEnumFields}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00031}{31}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.