Generated foxygen documentation. Closes #1
This commit is contained in:
191
docs/latex/structFrameInfo.tex
Normal file
191
docs/latex/structFrameInfo.tex
Normal file
@@ -0,0 +1,191 @@
|
||||
\hypertarget{structFrameInfo}{}\doxysection{Frame\+Info Struct Reference}
|
||||
\label{structFrameInfo}\index{FrameInfo@{FrameInfo}}
|
||||
|
||||
|
||||
Describes one CAN frame from a DBC file.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$frame\+\_\+info.\+h$>$}
|
||||
|
||||
\doxysubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{structFrameInfo_a7f2d192b7969f7b60479a48e1f7eba61}{Frame\+Info}} ()
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}{name}}
|
||||
\item
|
||||
std\+::uint32\+\_\+t \mbox{\hyperlink{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}{can\+Id}}
|
||||
\item
|
||||
bool \mbox{\hyperlink{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}{is\+Extended}}
|
||||
\item
|
||||
std\+::uint32\+\_\+t \mbox{\hyperlink{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}{pgn}}
|
||||
\item
|
||||
bool \mbox{\hyperlink{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}{has\+Pgn}}
|
||||
\item
|
||||
std\+::uint8\+\_\+t \mbox{\hyperlink{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}{dlc}}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}{transmitter}}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structFrameInfo_ace75121294f9d89b762080ab5643293c}{comment}}
|
||||
\item
|
||||
std\+::vector$<$ \mbox{\hyperlink{structSignalInfo}{Signal\+Info}} $>$ \mbox{\hyperlink{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}{signals}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Describes one CAN frame from a DBC file.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00024}{24}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\mbox{\Hypertarget{structFrameInfo_a7f2d192b7969f7b60479a48e1f7eba61}\label{structFrameInfo_a7f2d192b7969f7b60479a48e1f7eba61}}
|
||||
\index{FrameInfo@{FrameInfo}!FrameInfo@{FrameInfo}}
|
||||
\index{FrameInfo@{FrameInfo}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{FrameInfo()}{FrameInfo()}}
|
||||
{\footnotesize\ttfamily Frame\+Info\+::\+Frame\+Info (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00035}{35}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\mbox{\Hypertarget{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}\label{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}}
|
||||
\index{FrameInfo@{FrameInfo}!canId@{canId}}
|
||||
\index{canId@{canId}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{canId}{canId}}
|
||||
{\footnotesize\ttfamily std\+::uint32\+\_\+t Frame\+Info\+::can\+Id}
|
||||
|
||||
Normalized CAN identifier.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00026}{26}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}, and \mbox{\hyperlink{main_8cpp_source_l00023}{Print\+Tree()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_ace75121294f9d89b762080ab5643293c}\label{structFrameInfo_ace75121294f9d89b762080ab5643293c}}
|
||||
\index{FrameInfo@{FrameInfo}!comment@{comment}}
|
||||
\index{comment@{comment}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{comment}{comment}}
|
||||
{\footnotesize\ttfamily std\+::string Frame\+Info\+::comment}
|
||||
|
||||
Optional frame comment.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00032}{32}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, and \mbox{\hyperlink{dbc__parser_8cpp_source_l00274}{Dbc\+Parser\+::\+Parse\+Comment\+Line()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}\label{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}}
|
||||
\index{FrameInfo@{FrameInfo}!dlc@{dlc}}
|
||||
\index{dlc@{dlc}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{dlc}{dlc}}
|
||||
{\footnotesize\ttfamily std\+::uint8\+\_\+t Frame\+Info\+::dlc}
|
||||
|
||||
Frame payload length.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00030}{30}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}, and \mbox{\hyperlink{main_8cpp_source_l00023}{Print\+Tree()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}\label{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}}
|
||||
\index{FrameInfo@{FrameInfo}!hasPgn@{hasPgn}}
|
||||
\index{hasPgn@{hasPgn}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{hasPgn}{hasPgn}}
|
||||
{\footnotesize\ttfamily bool Frame\+Info\+::has\+Pgn}
|
||||
|
||||
true if PGN was derived.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00029}{29}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}, and \mbox{\hyperlink{main_8cpp_source_l00023}{Print\+Tree()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}\label{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}}
|
||||
\index{FrameInfo@{FrameInfo}!isExtended@{isExtended}}
|
||||
\index{isExtended@{isExtended}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{isExtended}{isExtended}}
|
||||
{\footnotesize\ttfamily bool Frame\+Info\+::is\+Extended}
|
||||
|
||||
true for extended frame.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00027}{27}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}, and \mbox{\hyperlink{main_8cpp_source_l00023}{Print\+Tree()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}\label{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}}
|
||||
\index{FrameInfo@{FrameInfo}!name@{name}}
|
||||
\index{name@{name}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{name}{name}}
|
||||
{\footnotesize\ttfamily std\+::string Frame\+Info\+::name}
|
||||
|
||||
Frame name.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00025}{25}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, and \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}\label{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}}
|
||||
\index{FrameInfo@{FrameInfo}!pgn@{pgn}}
|
||||
\index{pgn@{pgn}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{pgn}{pgn}}
|
||||
{\footnotesize\ttfamily std\+::uint32\+\_\+t Frame\+Info\+::pgn}
|
||||
|
||||
J1939 PGN if applicable.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00028}{28}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}, and \mbox{\hyperlink{main_8cpp_source_l00023}{Print\+Tree()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}\label{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}}
|
||||
\index{FrameInfo@{FrameInfo}!signals@{signals}}
|
||||
\index{signals@{signals}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{signals}{signals}}
|
||||
{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{structSignalInfo}{Signal\+Info}}$>$ Frame\+Info\+::signals}
|
||||
|
||||
Signals contained in the frame.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00033}{33}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__tree__builder_8cpp_source_l00014}{Dbc\+Tree\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, \mbox{\hyperlink{dbc__parser_8cpp_source_l00349}{Dbc\+Parser\+::\+Find\+Signal\+By\+Name()}}, and \mbox{\hyperlink{dbc__parser_8cpp_source_l00040}{Dbc\+Parser\+::\+Parse\+File()}}.
|
||||
|
||||
\mbox{\Hypertarget{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}\label{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}}
|
||||
\index{FrameInfo@{FrameInfo}!transmitter@{transmitter}}
|
||||
\index{transmitter@{transmitter}!FrameInfo@{FrameInfo}}
|
||||
\doxysubsubsection{\texorpdfstring{transmitter}{transmitter}}
|
||||
{\footnotesize\ttfamily std\+::string Frame\+Info\+::transmitter}
|
||||
|
||||
Transmitter ECU name.
|
||||
|
||||
Definition at line \mbox{\hyperlink{frame__info_8h_source_l00031}{31}} of file \mbox{\hyperlink{frame__info_8h_source}{frame\+\_\+info.\+h}}.
|
||||
|
||||
|
||||
|
||||
Referenced by \mbox{\hyperlink{dbc__decode__builder_8cpp_source_l00014}{Dbc\+Decode\+Builder\+::\+Build()}}, and \mbox{\hyperlink{dbc__parser_8cpp_source_l00142}{Dbc\+Parser\+::\+Parse\+Frame\+Line()}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{frame__info_8h}{frame\+\_\+info.\+h}}\end{DoxyCompactItemize}
|
||||
Reference in New Issue
Block a user