Files
lighthub/docs/latex/class_streamlog.tex
2022-01-06 02:01:16 +03:00

100 lines
5.7 KiB
TeX

\hypertarget{class_streamlog}{}\doxysection{Streamlog Class Reference}
\label{class_streamlog}\index{Streamlog@{Streamlog}}
{\ttfamily \#include $<$streamlog.\+h$>$}
Inheritance diagram for Streamlog\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_streamlog}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{class_streamlog_aa3d6de674a30268eeb1c3fcc45e9bd47}{Streamlog}} (\mbox{\hyperlink{streamlog_8h_ace67e7b92ea9c2ca0cf0cc6c201ccbc2}{Serial\+Port\+Type}} $\ast$\+\_\+serial\+Port, uint8\+\_\+t \+\_\+severity=\mbox{\hyperlink{streamlog_8h_a6ff63e8955665c4a58b1598f2b07c51a}{L\+O\+G\+\_\+\+D\+E\+B\+UG}}, uint8\+\_\+t \+\_\+led\+Pattern=0)
\item
void \mbox{\hyperlink{class_streamlog_ab9c1022fccf6b585b738f30f8577d613}{begin}} (unsigned long speed)
\item
void \mbox{\hyperlink{class_streamlog_ace6e3e265ae590b7f3b14b926bc3e60b}{end}} ()
\item
int \mbox{\hyperlink{class_streamlog_ae7a165675188ecb1bf305b025efbf47b}{available}} (void)
\item
int \mbox{\hyperlink{class_streamlog_a246066803cd501ca4f1f5c94823db0e0}{peek}} (void)
\item
int \mbox{\hyperlink{class_streamlog_acbea1e8e890180c66757bd7647703d54}{read}} (void)
\item
void \mbox{\hyperlink{class_streamlog_aec3522140e0c8f95039e62747f841987}{flush}} (void)
\item
size\+\_\+t \mbox{\hyperlink{class_streamlog_a944486d544c3677410e1505b9cd6858b}{write}} (uint8\+\_\+t ch)
\item
\mbox{\hyperlink{class_streamlog_adcd1dcab71fd1e1c9da5bc9c18ac3d1d}{operator bool}} ()
\end{DoxyCompactItemize}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_streamlog_aa3d6de674a30268eeb1c3fcc45e9bd47}\label{class_streamlog_aa3d6de674a30268eeb1c3fcc45e9bd47}}
\index{Streamlog@{Streamlog}!Streamlog@{Streamlog}}
\index{Streamlog@{Streamlog}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{Streamlog()}{Streamlog()}}
{\footnotesize\ttfamily Streamlog\+::\+Streamlog (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{streamlog_8h_ace67e7b92ea9c2ca0cf0cc6c201ccbc2}{Serial\+Port\+Type}} $\ast$}]{\+\_\+serial\+Port, }\item[{uint8\+\_\+t}]{\+\_\+severity = {\ttfamily \mbox{\hyperlink{streamlog_8h_a6ff63e8955665c4a58b1598f2b07c51a}{L\+O\+G\+\_\+\+D\+E\+B\+UG}}}, }\item[{uint8\+\_\+t}]{\+\_\+led\+Pattern = {\ttfamily 0} }\end{DoxyParamCaption})}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_streamlog_ae7a165675188ecb1bf305b025efbf47b}\label{class_streamlog_ae7a165675188ecb1bf305b025efbf47b}}
\index{Streamlog@{Streamlog}!available@{available}}
\index{available@{available}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{available()}{available()}}
{\footnotesize\ttfamily int Streamlog\+::available (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_ab9c1022fccf6b585b738f30f8577d613}\label{class_streamlog_ab9c1022fccf6b585b738f30f8577d613}}
\index{Streamlog@{Streamlog}!begin@{begin}}
\index{begin@{begin}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{begin()}{begin()}}
{\footnotesize\ttfamily void Streamlog\+::begin (\begin{DoxyParamCaption}\item[{unsigned long}]{speed }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_ace6e3e265ae590b7f3b14b926bc3e60b}\label{class_streamlog_ace6e3e265ae590b7f3b14b926bc3e60b}}
\index{Streamlog@{Streamlog}!end@{end}}
\index{end@{end}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{end()}{end()}}
{\footnotesize\ttfamily void Streamlog\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_aec3522140e0c8f95039e62747f841987}\label{class_streamlog_aec3522140e0c8f95039e62747f841987}}
\index{Streamlog@{Streamlog}!flush@{flush}}
\index{flush@{flush}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{flush()}{flush()}}
{\footnotesize\ttfamily void Streamlog\+::flush (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_adcd1dcab71fd1e1c9da5bc9c18ac3d1d}\label{class_streamlog_adcd1dcab71fd1e1c9da5bc9c18ac3d1d}}
\index{Streamlog@{Streamlog}!operator bool@{operator bool}}
\index{operator bool@{operator bool}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{operator bool()}{operator bool()}}
{\footnotesize\ttfamily Streamlog\+::operator bool (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
\mbox{\Hypertarget{class_streamlog_a246066803cd501ca4f1f5c94823db0e0}\label{class_streamlog_a246066803cd501ca4f1f5c94823db0e0}}
\index{Streamlog@{Streamlog}!peek@{peek}}
\index{peek@{peek}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{peek()}{peek()}}
{\footnotesize\ttfamily int Streamlog\+::peek (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_acbea1e8e890180c66757bd7647703d54}\label{class_streamlog_acbea1e8e890180c66757bd7647703d54}}
\index{Streamlog@{Streamlog}!read@{read}}
\index{read@{read}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{read()}{read()}}
{\footnotesize\ttfamily int Streamlog\+::read (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_streamlog_a944486d544c3677410e1505b9cd6858b}\label{class_streamlog_a944486d544c3677410e1505b9cd6858b}}
\index{Streamlog@{Streamlog}!write@{write}}
\index{write@{write}!Streamlog@{Streamlog}}
\doxysubsubsection{\texorpdfstring{write()}{write()}}
{\footnotesize\ttfamily size\+\_\+t Streamlog\+::write (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{ch }\end{DoxyParamCaption})}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{streamlog_8h}{streamlog.\+h}}\item
\mbox{\hyperlink{streamlog_8cpp}{streamlog.\+cpp}}\end{DoxyCompactItemize}