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

239
docs/latex/structDecodeSignal.tex Normal file
View File

@@ -0,0 +1,239 @@
\hypertarget{structDecodeSignal}{}\doxysection{Decode\+Signal Struct Reference}
\label{structDecodeSignal}\index{DecodeSignal@{DecodeSignal}}
Runtime-\/ready signal definition.
{\ttfamily \#include $<$decode\+\_\+database.\+h$>$}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{structDecodeSignal_a93fd97267e2614979440261628e493f5}{Decode\+Signal}} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
std\+::string \mbox{\hyperlink{structDecodeSignal_a58cf5844f2272a23dcb9687d912e4780}{name}}
\item
std\+::uint32\+\_\+t \mbox{\hyperlink{structDecodeSignal_aaf5d7527ddf65b6355c2b4f3626df22d}{start\+Bit}}
\item
std\+::uint32\+\_\+t \mbox{\hyperlink{structDecodeSignal_acd4ef5ee30421d117b5756854302debb}{length}}
\item
\mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}{Byte\+Order}} \mbox{\hyperlink{structDecodeSignal_abdc4c4bb4a67a6d61d6ca81e8a52833d}{byte\+Order}}
\item
\mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}{Value\+Type}} \mbox{\hyperlink{structDecodeSignal_a9d37638129263b8902ba5be59baf39a8}{value\+Type}}
\item
double \mbox{\hyperlink{structDecodeSignal_a428c39913a366a8476dd291061354391}{factor}}
\item
double \mbox{\hyperlink{structDecodeSignal_a92db637af4e224a0ae70173050dc3f74}{offset}}
\item
double \mbox{\hyperlink{structDecodeSignal_a0fb84e19a0ab3bd50b6f65c1075ebc25}{minimum}}
\item
double \mbox{\hyperlink{structDecodeSignal_a4a6ba87142a9badbf0ca830e9e709cb7}{maximum}}
\item
std\+::string \mbox{\hyperlink{structDecodeSignal_a38eed9ca7581423fd8bfbedcffc12092}{unit}}
\item
std\+::vector$<$ std\+::string $>$ \mbox{\hyperlink{structDecodeSignal_abdbae62a64d2df716bf60c6b67b30eaa}{receivers}}
\item
std\+::string \mbox{\hyperlink{structDecodeSignal_ae28c905d4a2bc86419c2a8361bfea473}{comment}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Runtime-\/ready signal definition.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00039}{39}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{structDecodeSignal_a93fd97267e2614979440261628e493f5}\label{structDecodeSignal_a93fd97267e2614979440261628e493f5}}
\index{DecodeSignal@{DecodeSignal}!DecodeSignal@{DecodeSignal}}
\index{DecodeSignal@{DecodeSignal}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{DecodeSignal()}{DecodeSignal()}}
{\footnotesize\ttfamily Decode\+Signal\+::\+Decode\+Signal (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00053}{53}} of file \mbox{\hyperlink{decode__database_8h_source}{decode\+\_\+database.\+h}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structDecodeSignal_abdc4c4bb4a67a6d61d6ca81e8a52833d}\label{structDecodeSignal_abdc4c4bb4a67a6d61d6ca81e8a52833d}}
\index{DecodeSignal@{DecodeSignal}!byteOrder@{byteOrder}}
\index{byteOrder@{byteOrder}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{byteOrder}{byteOrder}}
{\footnotesize\ttfamily \mbox{\hyperlink{decode__database_8h_aaeb92d42f5a6e27b8ba19f18d69d142b}{Byte\+Order}} Decode\+Signal\+::byte\+Order}
Intel or Motorola.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00043}{43}} 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_l00070}{Dbc\+Decoder\+::\+Extract\+Unsigned()}}.
\mbox{\Hypertarget{structDecodeSignal_ae28c905d4a2bc86419c2a8361bfea473}\label{structDecodeSignal_ae28c905d4a2bc86419c2a8361bfea473}}
\index{DecodeSignal@{DecodeSignal}!comment@{comment}}
\index{comment@{comment}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{comment}{comment}}
{\footnotesize\ttfamily std\+::string Decode\+Signal\+::comment}
Comment.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00051}{51}} 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{structDecodeSignal_a428c39913a366a8476dd291061354391}\label{structDecodeSignal_a428c39913a366a8476dd291061354391}}
\index{DecodeSignal@{DecodeSignal}!factor@{factor}}
\index{factor@{factor}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{factor}{factor}}
{\footnotesize\ttfamily double Decode\+Signal\+::factor}
Scaling factor.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00045}{45}} 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{structDecodeSignal_acd4ef5ee30421d117b5756854302debb}\label{structDecodeSignal_acd4ef5ee30421d117b5756854302debb}}
\index{DecodeSignal@{DecodeSignal}!length@{length}}
\index{length@{length}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{length}{length}}
{\footnotesize\ttfamily std\+::uint32\+\_\+t Decode\+Signal\+::length}
Signal length in bits.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00042}{42}} 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{\hyperlink{dbc__decoder_8cpp_source_l00031}{Dbc\+Decoder\+::\+Decode()}}, and \mbox{\hyperlink{dbc__decoder_8cpp_source_l00070}{Dbc\+Decoder\+::\+Extract\+Unsigned()}}.
\mbox{\Hypertarget{structDecodeSignal_a4a6ba87142a9badbf0ca830e9e709cb7}\label{structDecodeSignal_a4a6ba87142a9badbf0ca830e9e709cb7}}
\index{DecodeSignal@{DecodeSignal}!maximum@{maximum}}
\index{maximum@{maximum}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{maximum}{maximum}}
{\footnotesize\ttfamily double Decode\+Signal\+::maximum}
Maximum physical value.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00048}{48}} 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{structDecodeSignal_a0fb84e19a0ab3bd50b6f65c1075ebc25}\label{structDecodeSignal_a0fb84e19a0ab3bd50b6f65c1075ebc25}}
\index{DecodeSignal@{DecodeSignal}!minimum@{minimum}}
\index{minimum@{minimum}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{minimum}{minimum}}
{\footnotesize\ttfamily double Decode\+Signal\+::minimum}
Minimum physical value.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00047}{47}} 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{structDecodeSignal_a58cf5844f2272a23dcb9687d912e4780}\label{structDecodeSignal_a58cf5844f2272a23dcb9687d912e4780}}
\index{DecodeSignal@{DecodeSignal}!name@{name}}
\index{name@{name}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{name}{name}}
{\footnotesize\ttfamily std\+::string Decode\+Signal\+::name}
Signal name.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00040}{40}} 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{structDecodeSignal_a92db637af4e224a0ae70173050dc3f74}\label{structDecodeSignal_a92db637af4e224a0ae70173050dc3f74}}
\index{DecodeSignal@{DecodeSignal}!offset@{offset}}
\index{offset@{offset}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{offset}{offset}}
{\footnotesize\ttfamily double Decode\+Signal\+::offset}
Physical offset.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00046}{46}} 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{structDecodeSignal_abdbae62a64d2df716bf60c6b67b30eaa}\label{structDecodeSignal_abdbae62a64d2df716bf60c6b67b30eaa}}
\index{DecodeSignal@{DecodeSignal}!receivers@{receivers}}
\index{receivers@{receivers}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{receivers}{receivers}}
{\footnotesize\ttfamily std\+::vector$<$std\+::string$>$ Decode\+Signal\+::receivers}
Receivers.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00050}{50}} 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{structDecodeSignal_aaf5d7527ddf65b6355c2b4f3626df22d}\label{structDecodeSignal_aaf5d7527ddf65b6355c2b4f3626df22d}}
\index{DecodeSignal@{DecodeSignal}!startBit@{startBit}}
\index{startBit@{startBit}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{startBit}{startBit}}
{\footnotesize\ttfamily std\+::uint32\+\_\+t Decode\+Signal\+::start\+Bit}
DBC start bit.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00041}{41}} 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_l00070}{Dbc\+Decoder\+::\+Extract\+Unsigned()}}.
\mbox{\Hypertarget{structDecodeSignal_a38eed9ca7581423fd8bfbedcffc12092}\label{structDecodeSignal_a38eed9ca7581423fd8bfbedcffc12092}}
\index{DecodeSignal@{DecodeSignal}!unit@{unit}}
\index{unit@{unit}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{unit}{unit}}
{\footnotesize\ttfamily std\+::string Decode\+Signal\+::unit}
Physical unit.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00049}{49}} 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{structDecodeSignal_a9d37638129263b8902ba5be59baf39a8}\label{structDecodeSignal_a9d37638129263b8902ba5be59baf39a8}}
\index{DecodeSignal@{DecodeSignal}!valueType@{valueType}}
\index{valueType@{valueType}!DecodeSignal@{DecodeSignal}}
\doxysubsubsection{\texorpdfstring{valueType}{valueType}}
{\footnotesize\ttfamily \mbox{\hyperlink{decode__database_8h_ad9971b6ef33e02ba2c75d19c1d2518a1}{Value\+Type}} Decode\+Signal\+::value\+Type}
Signed or unsigned.
Definition at line \mbox{\hyperlink{decode__database_8h_source_l00044}{44}} 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()}}.
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{decode__database_8h}{decode\+\_\+database.\+h}}\end{DoxyCompactItemize}