utl/doc/latex/classutl_1_1__1wire__uart__i.tex
Christos Houtouridis bebb193278 DEV: minor changes
2019-11-14 12:24:04 +02:00

109 lines
6.6 KiB
TeX

\hypertarget{classutl_1_1__1wire__uart__i}{}\section{utl\+:\+:\+\_\+1wire\+\_\+uart\+\_\+i$<$ Impl\+\_\+t $>$ Class Template Reference}
\label{classutl_1_1__1wire__uart__i}\index{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i$<$ Impl\+\_\+t $>$@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i$<$ Impl\+\_\+t $>$}}
1-\/wire U\+A\+RT interface template class using C\+R\+TP Using the private virtual interface we provide the interface from \+\_\+1wire\+\_\+i$<$$>$
{\ttfamily \#include $<$\+\_\+1wire\+\_\+uart.\+h$>$}
Inheritance diagram for utl\+:\+:\+\_\+1wire\+\_\+uart\+\_\+i$<$ Impl\+\_\+t $>$\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classutl_1_1__1wire__uart__i}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item
using \mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}{type}} = \mbox{\hyperlink{classutl_1_1__1wire__uart__i}{\+\_\+1wire\+\_\+uart\+\_\+i}}$<$ Impl\+\_\+t $>$
\begin{DoxyCompactList}\small\item\em Export type as identity meta-\/function. \end{DoxyCompactList}\item
using \mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}{Speed}} = typename \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}$<$ \mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}{type}} $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}{Speed}}
\begin{DoxyCompactList}\small\item\em Bring bus speed. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{Indent}\textbf{ Object lifetime}\par
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classutl_1_1__1wire__uart__i_ae14ed1ce068d5601c5623c410a0dbc0c}{\+\_\+1wire\+\_\+uart\+\_\+i}} ()=default
\begin{DoxyCompactList}\small\item\em Allow constructor from derived only. \end{DoxyCompactList}\item
\mbox{\hyperlink{classutl_1_1__1wire__uart__i_afe64da15b5eaf61cd54f357f3ea8b3ea}{$\sim$\+\_\+1wire\+\_\+uart\+\_\+i}} ()=default
\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Additional Inherited Members}
\subsection{Detailed Description}
\subsubsection*{template$<$typename Impl\+\_\+t$>$\newline
class utl\+::\+\_\+1wire\+\_\+uart\+\_\+i$<$ Impl\+\_\+t $>$}
1-\/wire U\+A\+RT interface template class using C\+R\+TP Using the private virtual interface we provide the interface from \+\_\+1wire\+\_\+i$<$$>$
A 1-\/wire implementation using a microprocessor\textquotesingle{}s uart for bit timing inherited from \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} base class. \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}
\end{DoxySeeAlso}
Definition at line 52 of file \+\_\+1wire\+\_\+uart.\+h.
\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}\label{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}}
\index{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}!Speed@{Speed}}
\index{Speed@{Speed}!utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}
\subsubsection{\texorpdfstring{Speed}{Speed}}
{\footnotesize\ttfamily template$<$typename Impl\+\_\+t$>$ \\
using \mbox{\hyperlink{classutl_1_1__1wire__uart__i}{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}$<$ Impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}{Speed}} = typename \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}$<$\mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}{type}}$>$\+::\mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc4364e3aa029405a9b2b25e1fea83ac}{Speed}}}
Bring bus speed.
Definition at line 57 of file \+\_\+1wire\+\_\+uart.\+h.
\mbox{\Hypertarget{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}\label{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}}
\index{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}!type@{type}}
\index{type@{type}!utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}
\subsubsection{\texorpdfstring{type}{type}}
{\footnotesize\ttfamily template$<$typename Impl\+\_\+t$>$ \\
using \mbox{\hyperlink{classutl_1_1__1wire__uart__i}{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}$<$ Impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__uart__i_acc885c6ec2395ad20409b01aa4d5f546}{type}} = \mbox{\hyperlink{classutl_1_1__1wire__uart__i}{\+\_\+1wire\+\_\+uart\+\_\+i}}$<$Impl\+\_\+t$>$}
Export type as identity meta-\/function.
Definition at line 56 of file \+\_\+1wire\+\_\+uart.\+h.
\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classutl_1_1__1wire__uart__i_ae14ed1ce068d5601c5623c410a0dbc0c}\label{classutl_1_1__1wire__uart__i_ae14ed1ce068d5601c5623c410a0dbc0c}}
\index{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}!\+\_\+1wire\+\_\+uart\+\_\+i@{\+\_\+1wire\+\_\+uart\+\_\+i}}
\index{\+\_\+1wire\+\_\+uart\+\_\+i@{\+\_\+1wire\+\_\+uart\+\_\+i}!utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+uart\+\_\+i()}{\_1wire\_uart\_i()}}
{\footnotesize\ttfamily template$<$typename Impl\+\_\+t$>$ \\
\mbox{\hyperlink{classutl_1_1__1wire__uart__i}{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}$<$ Impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__uart__i}{\+\_\+1wire\+\_\+uart\+\_\+i}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
Allow constructor from derived only.
\mbox{\Hypertarget{classutl_1_1__1wire__uart__i_afe64da15b5eaf61cd54f357f3ea8b3ea}\label{classutl_1_1__1wire__uart__i_afe64da15b5eaf61cd54f357f3ea8b3ea}}
\index{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}!````~\+\_\+1wire\+\_\+uart\+\_\+i@{$\sim$\+\_\+1wire\+\_\+uart\+\_\+i}}
\index{````~\+\_\+1wire\+\_\+uart\+\_\+i@{$\sim$\+\_\+1wire\+\_\+uart\+\_\+i}!utl\+::\+\_\+1wire\+\_\+uart\+\_\+i@{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}
\subsubsection{\texorpdfstring{$\sim$\+\_\+1wire\+\_\+uart\+\_\+i()}{~\_1wire\_uart\_i()}}
{\footnotesize\ttfamily template$<$typename Impl\+\_\+t$>$ \\
\mbox{\hyperlink{classutl_1_1__1wire__uart__i}{utl\+::\+\_\+1wire\+\_\+uart\+\_\+i}}$<$ Impl\+\_\+t $>$\+::$\sim$\mbox{\hyperlink{classutl_1_1__1wire__uart__i}{\+\_\+1wire\+\_\+uart\+\_\+i}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
Allow destructor from derived only
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
include/utl/com/\mbox{\hyperlink{__1wire__uart_8h}{\+\_\+1wire\+\_\+uart.\+h}}\end{DoxyCompactItemize}