Generated foxygen documentation. Closes #1
This commit is contained in:
191
docs/latex/structDecodeFrame.tex
Normal file
191
docs/latex/structDecodeFrame.tex
Normal file
@@ -0,0 +1,191 @@
|
||||
\hypertarget{structDecodeFrame}{}\doxysection{Decode\+Frame Struct Reference}
|
||||
\label{structDecodeFrame}\index{DecodeFrame@{DecodeFrame}}
|
||||
|
||||
|
||||
Runtime-\/ready frame definition.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$decode\+\_\+database.\+h$>$}
|
||||
|
||||
\doxysubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{structDecodeFrame_ae6ae88ee29bcaff936e7c7b2380f96b4}{Decode\+Frame}} ()
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structDecodeFrame_aa0a7f8fd5bfde2148dfd0d838328f579}{name}}
|
||||
\item
|
||||
std\+::uint32\+\_\+t \mbox{\hyperlink{structDecodeFrame_a52e10215388db7df8b541b9d9909edcf}{can\+Id}}
|
||||
\item
|
||||
bool \mbox{\hyperlink{structDecodeFrame_a3ee2348d781f8f15aaf87e8dcf57ec41}{is\+Extended}}
|
||||
\item
|
||||
std\+::uint8\+\_\+t \mbox{\hyperlink{structDecodeFrame_a51111ac13988be372d5673d12cf3e060}{dlc}}
|
||||
\item
|
||||
std\+::uint32\+\_\+t \mbox{\hyperlink{structDecodeFrame_a1d3c54055c0cbceb73adf551f7067f23}{pgn}}
|
||||
\item
|
||||
bool \mbox{\hyperlink{structDecodeFrame_a2551102670c4a540fced4c71da0b369d}{has\+Pgn}}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structDecodeFrame_ad78241dc40c793aabb8495b6989b81a9}{transmitter}}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structDecodeFrame_a25819ef907a32391af5c9f7cae9cdb22}{comment}}
|
||||
\item
|
||||
std\+::vector$<$ \mbox{\hyperlink{structDecodeSignal}{Decode\+Signal}} $>$ \mbox{\hyperlink{structDecodeFrame_a372afd9e74f1ae33f85cb4acfd3e2036}{signals}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Runtime-\/ready frame definition.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00072}{72}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\mbox{\Hypertarget{structDecodeFrame_ae6ae88ee29bcaff936e7c7b2380f96b4}\label{structDecodeFrame_ae6ae88ee29bcaff936e7c7b2380f96b4}}
|
||||
\index{DecodeFrame@{DecodeFrame}!DecodeFrame@{DecodeFrame}}
|
||||
\index{DecodeFrame@{DecodeFrame}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{DecodeFrame()}{DecodeFrame()}}
|
||||
{\footnotesize\ttfamily Decode\+Frame\+::\+Decode\+Frame (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00083}{83}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\mbox{\Hypertarget{structDecodeFrame_a52e10215388db7df8b541b9d9909edcf}\label{structDecodeFrame_a52e10215388db7df8b541b9d9909edcf}}
|
||||
\index{DecodeFrame@{DecodeFrame}!canId@{canId}}
|
||||
\index{canId@{canId}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{canId}{canId}}
|
||||
{\footnotesize\ttfamily std\+::uint32\+\_\+t Decode\+Frame\+::can\+Id}
|
||||
|
||||
Normalized CAN ID.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00074}{74}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a25819ef907a32391af5c9f7cae9cdb22}\label{structDecodeFrame_a25819ef907a32391af5c9f7cae9cdb22}}
|
||||
\index{DecodeFrame@{DecodeFrame}!comment@{comment}}
|
||||
\index{comment@{comment}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{comment}{comment}}
|
||||
{\footnotesize\ttfamily std\+::string Decode\+Frame\+::comment}
|
||||
|
||||
Frame comment.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00080}{80}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a51111ac13988be372d5673d12cf3e060}\label{structDecodeFrame_a51111ac13988be372d5673d12cf3e060}}
|
||||
\index{DecodeFrame@{DecodeFrame}!dlc@{dlc}}
|
||||
\index{dlc@{dlc}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{dlc}{dlc}}
|
||||
{\footnotesize\ttfamily std\+::uint8\+\_\+t Decode\+Frame\+::dlc}
|
||||
|
||||
Payload length.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00076}{76}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a2551102670c4a540fced4c71da0b369d}\label{structDecodeFrame_a2551102670c4a540fced4c71da0b369d}}
|
||||
\index{DecodeFrame@{DecodeFrame}!hasPgn@{hasPgn}}
|
||||
\index{hasPgn@{hasPgn}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{hasPgn}{hasPgn}}
|
||||
{\footnotesize\ttfamily bool Decode\+Frame\+::has\+Pgn}
|
||||
|
||||
true if PGN is valid.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00078}{78}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a3ee2348d781f8f15aaf87e8dcf57ec41}\label{structDecodeFrame_a3ee2348d781f8f15aaf87e8dcf57ec41}}
|
||||
\index{DecodeFrame@{DecodeFrame}!isExtended@{isExtended}}
|
||||
\index{isExtended@{isExtended}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{isExtended}{isExtended}}
|
||||
{\footnotesize\ttfamily bool Decode\+Frame\+::is\+Extended}
|
||||
|
||||
true for extended frame.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00075}{75}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_aa0a7f8fd5bfde2148dfd0d838328f579}\label{structDecodeFrame_aa0a7f8fd5bfde2148dfd0d838328f579}}
|
||||
\index{DecodeFrame@{DecodeFrame}!name@{name}}
|
||||
\index{name@{name}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{name}{name}}
|
||||
{\footnotesize\ttfamily std\+::string Decode\+Frame\+::name}
|
||||
|
||||
Frame name.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00073}{73}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, and \mbox{\hyperlink{main_8cpp_source_l00075}{Print\+Decoded\+Frame()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a1d3c54055c0cbceb73adf551f7067f23}\label{structDecodeFrame_a1d3c54055c0cbceb73adf551f7067f23}}
|
||||
\index{DecodeFrame@{DecodeFrame}!pgn@{pgn}}
|
||||
\index{pgn@{pgn}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{pgn}{pgn}}
|
||||
{\footnotesize\ttfamily std\+::uint32\+\_\+t Decode\+Frame\+::pgn}
|
||||
|
||||
PGN if available.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00077}{77}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_a372afd9e74f1ae33f85cb4acfd3e2036}\label{structDecodeFrame_a372afd9e74f1ae33f85cb4acfd3e2036}}
|
||||
\index{DecodeFrame@{DecodeFrame}!signals@{signals}}
|
||||
\index{signals@{signals}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{signals}{signals}}
|
||||
{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{structDecodeSignal}{Decode\+Signal}}$>$ Decode\+Frame\+::signals}
|
||||
|
||||
Signal definitions.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00081}{81}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, and \mbox{\hyperlink{dbc__decoder_8cpp_source_l00031}{Dbc\+Decoder\+::\+Decode()}}.
|
||||
|
||||
\mbox{\Hypertarget{structDecodeFrame_ad78241dc40c793aabb8495b6989b81a9}\label{structDecodeFrame_ad78241dc40c793aabb8495b6989b81a9}}
|
||||
\index{DecodeFrame@{DecodeFrame}!transmitter@{transmitter}}
|
||||
\index{transmitter@{transmitter}!DecodeFrame@{DecodeFrame}}
|
||||
\doxysubsubsection{\texorpdfstring{transmitter}{transmitter}}
|
||||
{\footnotesize\ttfamily std\+::string Decode\+Frame\+::transmitter}
|
||||
|
||||
Transmitter ECU.
|
||||
|
||||
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00079}{79}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{decode__database_8h}{decode\+\_\+database.\+h}}\end{DoxyCompactItemize}
|
||||
Reference in New Issue
Block a user