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

110
docs/latex/structFrameKey.tex Normal file
View File

@@ -0,0 +1,110 @@
\hypertarget{structFrameKey}{}\doxysection{Frame\+Key Struct Reference}
\label{structFrameKey}\index{FrameKey@{FrameKey}}
Key for fast frame lookup.
{\ttfamily \#include $<$decode\+\_\+database.\+h$>$}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{structFrameKey_a0e9aad56b251cdf802d45a9c19050b14}{Frame\+Key}} ()
\item
\mbox{\hyperlink{structFrameKey_a33bde405c7ea53000d54b3dd6e058670}{Frame\+Key}} (std\+::uint32\+\_\+t id, bool extended)
\item
bool \mbox{\hyperlink{structFrameKey_aaaec9f914e127787247fcda5e183b01f}{operator==}} (const \mbox{\hyperlink{structFrameKey}{Frame\+Key}} \&other) const
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
std\+::uint32\+\_\+t \mbox{\hyperlink{structFrameKey_a022917652b4d3c2f2dfcc5a13ab7caa4}{can\+Id}}
\item
bool \mbox{\hyperlink{structFrameKey_aa3179b709d02ef70cf0e736f040a2145}{is\+Extended}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Key for fast frame lookup.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00099}{99}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{structFrameKey_a0e9aad56b251cdf802d45a9c19050b14}\label{structFrameKey_a0e9aad56b251cdf802d45a9c19050b14}}
\index{FrameKey@{FrameKey}!FrameKey@{FrameKey}}
\index{FrameKey@{FrameKey}!FrameKey@{FrameKey}}
\doxysubsubsection{\texorpdfstring{FrameKey()}{FrameKey()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Frame\+Key\+::\+Frame\+Key (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00103}{103}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\mbox{\Hypertarget{structFrameKey_a33bde405c7ea53000d54b3dd6e058670}\label{structFrameKey_a33bde405c7ea53000d54b3dd6e058670}}
\index{FrameKey@{FrameKey}!FrameKey@{FrameKey}}
\index{FrameKey@{FrameKey}!FrameKey@{FrameKey}}
\doxysubsubsection{\texorpdfstring{FrameKey()}{FrameKey()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Frame\+Key\+::\+Frame\+Key (\begin{DoxyParamCaption}\item[{std\+::uint32\+\_\+t}]{id, }\item[{bool}]{extended }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00108}{108}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{structFrameKey_aaaec9f914e127787247fcda5e183b01f}\label{structFrameKey_aaaec9f914e127787247fcda5e183b01f}}
\index{FrameKey@{FrameKey}!operator==@{operator==}}
\index{operator==@{operator==}!FrameKey@{FrameKey}}
\doxysubsubsection{\texorpdfstring{operator==()}{operator==()}}
{\footnotesize\ttfamily bool Frame\+Key\+::operator== (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structFrameKey}{Frame\+Key}} \&}]{other }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00113}{113}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
References \mbox{\hyperlink{decode__database_8h_source_l00100}{can\+Id}}, and \mbox{\hyperlink{decode__database_8h_source_l00101}{is\+Extended}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structFrameKey_a022917652b4d3c2f2dfcc5a13ab7caa4}\label{structFrameKey_a022917652b4d3c2f2dfcc5a13ab7caa4}}
\index{FrameKey@{FrameKey}!canId@{canId}}
\index{canId@{canId}!FrameKey@{FrameKey}}
\doxysubsubsection{\texorpdfstring{canId}{canId}}
{\footnotesize\ttfamily std\+::uint32\+\_\+t Frame\+Key\+::can\+Id}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00100}{100}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
Referenced by \mbox{\hyperlink{decode__database_8h_source_l00122}{Frame\+Key\+Hasher\+::operator()()}}, and \mbox{\hyperlink{decode__database_8h_source_l00113}{operator==()}}.
\mbox{\Hypertarget{structFrameKey_aa3179b709d02ef70cf0e736f040a2145}\label{structFrameKey_aa3179b709d02ef70cf0e736f040a2145}}
\index{FrameKey@{FrameKey}!isExtended@{isExtended}}
\index{isExtended@{isExtended}!FrameKey@{FrameKey}}
\doxysubsubsection{\texorpdfstring{isExtended}{isExtended}}
{\footnotesize\ttfamily bool Frame\+Key\+::is\+Extended}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00101}{101}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
Referenced by \mbox{\hyperlink{decode__database_8h_source_l00122}{Frame\+Key\+Hasher\+::operator()()}}, and \mbox{\hyperlink{decode__database_8h_source_l00113}{operator==()}}.
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{decode__database_8h}{decode\+\_\+database.\+h}}\end{DoxyCompactItemize}