Files
dbc/docs/latex/signal__info_8h_source.tex

58 lines
8.5 KiB
TeX

\hypertarget{signal__info_8h_source}{}\doxysection{signal\+\_\+info.\+h}
\mbox{\hyperlink{signal__info_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00001}00001 \textcolor{comment}{/**}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00002}00002 \textcolor{comment}{ * @file signal\_info.h}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00003}00003 \textcolor{comment}{ * @brief}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00004}00004 \textcolor{comment}{ *}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00005}00005 \textcolor{comment}{ * Created: 2026-\/03-\/13}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00006}00006 \textcolor{comment}{ * Author: Deeaitch (Dim. Himro)}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00007}00007 \textcolor{comment}{ *}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00008}00008 \textcolor{comment}{ * Licensed under the MIT License.}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00009}00009 \textcolor{comment}{ * See LICENSE file in the project root for full license text.}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00010}00010 \textcolor{comment}{ */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00011}00011 }
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00012}00012 \textcolor{preprocessor}{\#ifndef SIGNAL\_INFO\_H}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00013}00013 \textcolor{preprocessor}{\#define SIGNAL\_INFO\_H}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00014}00014 }
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00015}00015 \textcolor{preprocessor}{\#include <string>}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00016}00016 \textcolor{preprocessor}{\#include <vector>}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00017}00017 \textcolor{preprocessor}{\#include <cstdint>}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00018}00018 \textcolor{comment}{}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00019}00019 \textcolor{comment}{/**}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00020}00020 \textcolor{comment}{ * @brief Describes one signal inside a DBC frame.}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00021}00021 \textcolor{comment}{ */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00022}\mbox{\hyperlink{structSignalInfo}{00022}} \textcolor{keyword}{struct }\mbox{\hyperlink{structSignalInfo}{SignalInfo}} \{}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00023}\mbox{\hyperlink{structSignalInfo_a379e422a00cad56f896cacf60455b088}{00023}} std::string \mbox{\hyperlink{structSignalInfo_a379e422a00cad56f896cacf60455b088}{name}}; \textcolor{comment}{/**< Signal name. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00024}\mbox{\hyperlink{structSignalInfo_ace290724f9801521609aedaa946d61f1}{00024}} std::uint32\_t \mbox{\hyperlink{structSignalInfo_ace290724f9801521609aedaa946d61f1}{startBit}}; \textcolor{comment}{/**< Start bit in DBC notation. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00025}\mbox{\hyperlink{structSignalInfo_a1008b5201f71848177217bd52fb84baa}{00025}} std::uint32\_t \mbox{\hyperlink{structSignalInfo_a1008b5201f71848177217bd52fb84baa}{length}}; \textcolor{comment}{/**< Signal length in bits. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00026}\mbox{\hyperlink{structSignalInfo_af363b1563fb4c7cc8973f9a80c06846c}{00026}} \textcolor{keywordtype}{bool} \mbox{\hyperlink{structSignalInfo_af363b1563fb4c7cc8973f9a80c06846c}{isLittleEndian}}; \textcolor{comment}{/**< true for Intel, false for Motorola. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00027}\mbox{\hyperlink{structSignalInfo_a52a52b320eef92fbcb4626307f9a498f}{00027}} \textcolor{keywordtype}{bool} \mbox{\hyperlink{structSignalInfo_a52a52b320eef92fbcb4626307f9a498f}{isSigned}}; \textcolor{comment}{/**< true if signal is signed. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00028}\mbox{\hyperlink{structSignalInfo_ae4f78d99a2750aa564d7eba860171499}{00028}} \textcolor{keywordtype}{double} \mbox{\hyperlink{structSignalInfo_ae4f78d99a2750aa564d7eba860171499}{factor}}; \textcolor{comment}{/**< Scaling factor. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00029}\mbox{\hyperlink{structSignalInfo_ab7d0769f47aa540656b22e4e49db517e}{00029}} \textcolor{keywordtype}{double} \mbox{\hyperlink{structSignalInfo_ab7d0769f47aa540656b22e4e49db517e}{offset}}; \textcolor{comment}{/**< Physical offset. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00030}\mbox{\hyperlink{structSignalInfo_ada7bf94fbeaa26bd08c73982b5af255b}{00030}} \textcolor{keywordtype}{double} \mbox{\hyperlink{structSignalInfo_ada7bf94fbeaa26bd08c73982b5af255b}{minimum}}; \textcolor{comment}{/**< Minimum physical value. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00031}\mbox{\hyperlink{structSignalInfo_adf1c4331b9eabced0d7fdda40ff0eb52}{00031}} \textcolor{keywordtype}{double} \mbox{\hyperlink{structSignalInfo_adf1c4331b9eabced0d7fdda40ff0eb52}{maximum}}; \textcolor{comment}{/**< Maximum physical value. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00032}\mbox{\hyperlink{structSignalInfo_a1f214f03e94ef5794de2d3367bfcbd01}{00032}} std::string \mbox{\hyperlink{structSignalInfo_a1f214f03e94ef5794de2d3367bfcbd01}{unit}}; \textcolor{comment}{/**< Physical unit. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00033}\mbox{\hyperlink{structSignalInfo_a2c95562fd0b29327a7fd7b1e6feee7f3}{00033}} std::vector<std::string> \mbox{\hyperlink{structSignalInfo_a2c95562fd0b29327a7fd7b1e6feee7f3}{receivers}}; \textcolor{comment}{/**< Signal receivers. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00034}\mbox{\hyperlink{structSignalInfo_ac99ba7563a5dad01e39c4257216953f5}{00034}} std::string \mbox{\hyperlink{structSignalInfo_ac99ba7563a5dad01e39c4257216953f5}{comment}}; \textcolor{comment}{/**< Optional signal comment. */}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00035}00035 }
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00036}\mbox{\hyperlink{structSignalInfo_aa2d2cd238118015258e271dce92a971e}{00036}} \mbox{\hyperlink{structSignalInfo_aa2d2cd238118015258e271dce92a971e}{SignalInfo}}()}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00037}00037 : \mbox{\hyperlink{structSignalInfo_a379e422a00cad56f896cacf60455b088}{name}}()}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00038}00038 , \mbox{\hyperlink{structSignalInfo_ace290724f9801521609aedaa946d61f1}{startBit}} (0U)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00039}00039 , \mbox{\hyperlink{structSignalInfo_a1008b5201f71848177217bd52fb84baa}{length}} (0U)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00040}00040 , \mbox{\hyperlink{structSignalInfo_af363b1563fb4c7cc8973f9a80c06846c}{isLittleEndian}} (true)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00041}00041 , \mbox{\hyperlink{structSignalInfo_a52a52b320eef92fbcb4626307f9a498f}{isSigned}} (false)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00042}00042 , \mbox{\hyperlink{structSignalInfo_ae4f78d99a2750aa564d7eba860171499}{factor}} (1.0)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00043}00043 , \mbox{\hyperlink{structSignalInfo_ab7d0769f47aa540656b22e4e49db517e}{offset}} (0.0)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00044}00044 , \mbox{\hyperlink{structSignalInfo_ada7bf94fbeaa26bd08c73982b5af255b}{minimum}} (0.0)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00045}00045 , \mbox{\hyperlink{structSignalInfo_adf1c4331b9eabced0d7fdda40ff0eb52}{maximum}} (0.0)}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00046}00046 , \mbox{\hyperlink{structSignalInfo_a1f214f03e94ef5794de2d3367bfcbd01}{unit}}()}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00047}00047 , \mbox{\hyperlink{structSignalInfo_a2c95562fd0b29327a7fd7b1e6feee7f3}{receivers}}()}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00048}00048 , \mbox{\hyperlink{structSignalInfo_ac99ba7563a5dad01e39c4257216953f5}{comment}}() \{}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00049}00049 \}}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00050}00050 \};}
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00051}00051 }
\DoxyCodeLine{\Hypertarget{signal__info_8h_source_l00052}00052 \textcolor{preprocessor}{\#endif }\textcolor{comment}{/* SIGNAL\_INFO\_H */}\textcolor{preprocessor}{}}
\end{DoxyCode}