Files
dbc/docs/latex/frame__info_8h_source.tex

54 lines
7.2 KiB
TeX

\hypertarget{frame__info_8h_source}{}\doxysection{frame\+\_\+info.\+h}
\mbox{\hyperlink{frame__info_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00001}00001 \textcolor{comment}{/**}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00002}00002 \textcolor{comment}{ * @file frame\_info.h}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00003}00003 \textcolor{comment}{ * @brief}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00004}00004 \textcolor{comment}{ *}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00005}00005 \textcolor{comment}{ * Created: 2026-\/03-\/13}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00006}00006 \textcolor{comment}{ * Author: Deeaitch (Dim. Himro)}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00007}00007 \textcolor{comment}{ *}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00008}00008 \textcolor{comment}{ * Licensed under the MIT License.}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00009}00009 \textcolor{comment}{ * See LICENSE file in the project root for full license text.}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00010}00010 \textcolor{comment}{ */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00011}00011 }
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00012}00012 \textcolor{preprocessor}{\#ifndef FRAME\_INFO\_H}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00013}00013 \textcolor{preprocessor}{\#define FRAME\_INFO\_H}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00014}00014 }
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00015}00015 \textcolor{preprocessor}{\#include <string>}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00016}00016 \textcolor{preprocessor}{\#include <vector>}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00017}00017 \textcolor{preprocessor}{\#include <cstdint>}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00018}00018 }
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00019}00019 \textcolor{preprocessor}{\#include "{}\mbox{\hyperlink{signal__info_8h}{signal\_info.h}}"{}}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00020}00020 \textcolor{comment}{}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00021}00021 \textcolor{comment}{/**}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00022}00022 \textcolor{comment}{ * @brief Describes one CAN frame from a DBC file.}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00023}00023 \textcolor{comment}{ */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00024}\mbox{\hyperlink{structFrameInfo}{00024}} \textcolor{keyword}{struct }\mbox{\hyperlink{structFrameInfo}{FrameInfo}} \{}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00025}\mbox{\hyperlink{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}{00025}} std::string \mbox{\hyperlink{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}{name}}; \textcolor{comment}{/**< Frame name. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00026}\mbox{\hyperlink{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}{00026}} std::uint32\_t \mbox{\hyperlink{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}{canId}}; \textcolor{comment}{/**< Normalized CAN identifier. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00027}\mbox{\hyperlink{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}{00027}} \textcolor{keywordtype}{bool} \mbox{\hyperlink{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}{isExtended}}; \textcolor{comment}{/**< true for extended frame. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00028}\mbox{\hyperlink{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}{00028}} std::uint32\_t \mbox{\hyperlink{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}{pgn}}; \textcolor{comment}{/**< J1939 PGN if applicable. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00029}\mbox{\hyperlink{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}{00029}} \textcolor{keywordtype}{bool} \mbox{\hyperlink{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}{hasPgn}}; \textcolor{comment}{/**< true if PGN was derived. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00030}\mbox{\hyperlink{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}{00030}} std::uint8\_t \mbox{\hyperlink{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}{dlc}}; \textcolor{comment}{/**< Frame payload length. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00031}\mbox{\hyperlink{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}{00031}} std::string \mbox{\hyperlink{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}{transmitter}}; \textcolor{comment}{/**< Transmitter ECU name. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00032}\mbox{\hyperlink{structFrameInfo_ace75121294f9d89b762080ab5643293c}{00032}} std::string \mbox{\hyperlink{structFrameInfo_ace75121294f9d89b762080ab5643293c}{comment}}; \textcolor{comment}{/**< Optional frame comment. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00033}\mbox{\hyperlink{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}{00033}} std::vector<SignalInfo> \mbox{\hyperlink{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}{signals}}; \textcolor{comment}{/**< Signals contained in the frame. */}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00034}00034 }
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00035}\mbox{\hyperlink{structFrameInfo_a7f2d192b7969f7b60479a48e1f7eba61}{00035}} \mbox{\hyperlink{structFrameInfo_a7f2d192b7969f7b60479a48e1f7eba61}{FrameInfo}}()}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00036}00036 : \mbox{\hyperlink{structFrameInfo_abb53a7f93ed7abc0ea1ae4a8ccafcdcb}{name}}()}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00037}00037 , \mbox{\hyperlink{structFrameInfo_af470b0742c05bfbffc31c51a68f5c05e}{canId}} (0U)}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00038}00038 , \mbox{\hyperlink{structFrameInfo_a34b726afaad2ac5c697fdb2ac070cdaf}{isExtended}} (false)}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00039}00039 , \mbox{\hyperlink{structFrameInfo_aee518b33f1000bf0b7f6e4a87474c943}{pgn}} (0U)}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00040}00040 , \mbox{\hyperlink{structFrameInfo_a4737a5420213ad4304724e39f3a4e55d}{hasPgn}} (false)}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00041}00041 , \mbox{\hyperlink{structFrameInfo_aa2b198ea0f55e560c123d35e7b3ecab9}{dlc}} (0U)}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00042}00042 , \mbox{\hyperlink{structFrameInfo_a92749ec3798d4211a505860fb389a9e8}{transmitter}}()}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00043}00043 , \mbox{\hyperlink{structFrameInfo_ace75121294f9d89b762080ab5643293c}{comment}}()}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00044}00044 , \mbox{\hyperlink{structFrameInfo_a942937027f1af06536f98cc23b2bf6ce}{signals}}() \{}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00045}00045 \}}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00046}00046 \};}
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00047}00047 }
\DoxyCodeLine{\Hypertarget{frame__info_8h_source_l00048}00048 \textcolor{preprocessor}{\#endif }\textcolor{comment}{/* FRAME\_INFO\_H */}\textcolor{preprocessor}{}}
\end{DoxyCode}