481 lines
36 KiB
TeX
481 lines
36 KiB
TeX
\hypertarget{classutl_1_1__1wire__i}{}\section{utl\+:\+:\+\_\+1wire\+\_\+i$<$ impl\+\_\+t $>$ Class Template Reference}
|
|
\label{classutl_1_1__1wire__i}\index{utl\+::\+\_\+1wire\+\_\+i$<$ impl\+\_\+t $>$@{utl\+::\+\_\+1wire\+\_\+i$<$ impl\+\_\+t $>$}}
|
|
|
|
|
|
Template base class for 1-\/wire communication interface using C\+R\+TP.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$\+\_\+1wire.\+h$>$}
|
|
|
|
\subsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} \{ \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}} =0,
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cca1cbf38b04c4249d8ec27d1ec96aaff68}{Speed\+::\+O\+V\+DR}}
|
|
\}
|
|
\begin{DoxyCompactList}\small\item\em 1-\/wire bus speed \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{classutl_1_1__1wire__i_afb63e64403924897a8277eb4159ebd44}{type}} = \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}
|
|
\begin{DoxyCompactList}\small\item\em Export type as identity meta-\/function. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{Indent}\textbf{ User functionality provided by the interface}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
bool \mbox{\hyperlink{classutl_1_1__1wire__i_a0a7ef731162e81e0e2e07ae9cb9e6ffa}{reset}} (\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\begin{DoxyCompactList}\small\item\em Generate a 1-\/wire reset. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_a59e7196e10e53467b62ed369ff78f07d}{tx\+\_\+data}} (\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} out, \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_ab3bd112ff66074bdaf7357b91ca692a8}{tx\+\_\+data}} (const \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$out, \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$in, \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} n, \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_a2585e7166d14b7f36bd47db2e43cc0b1}{rx\+\_\+data}} (\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_ad20382d5d50ee7d457bc4079b9c38a2a}{rx\+\_\+data}} (\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$in, \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} n, \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i_aa2d87a149c4e5dcfefc5a8cde6eaefb2}{match}} (\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id, \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i_ac88f67dd75dc23d39123ac584dce6b40}{match\+\_\+n\+\_\+ovdr}} (\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id)
|
|
\item
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i_a0a405f818fd45eb2799e6b4477021a0a}{skip}} (\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}})
|
|
\item
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i_a8b0b0ea95c02a40721f1e159119b3506}{skip\+\_\+n\+\_\+ovdr}} ()
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_a4b6d225963095d36eda832a1e0adba55}{first}} (\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}, bool alarm=false)
|
|
\begin{DoxyCompactList}\small\item\em \textquotesingle{}first\textquotesingle{} operation, to search on the 1-\/\+Wire for the first device. This is performed by setting dec\+\_\+, pos\+\_\+ and cur\+\_\+ to zero and then doing the search. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_a3e302085f12a39fef8a378e1dac42f45}{next}} (\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}} s=\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}, bool alarm=false)
|
|
\begin{DoxyCompactList}\small\item\em \textquotesingle{}next\textquotesingle{} operation, to search on the 1-\/\+Wire for the next device. This search is usually performed after a \textquotesingle{}first\textquotesingle{} operation or another \textquotesingle{}next\textquotesingle{} operation. Based on maxim-\/ic application note 187. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\end{Indent}
|
|
\subsection*{Protected Member Functions}
|
|
\begin{Indent}\textbf{ Object lifetime}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i_a4839577d00fdcefb51ac8d4cd91f0f1a}{\+\_\+1wire\+\_\+i}} ()=default
|
|
\begin{DoxyCompactList}\small\item\em Allow constructor from derived only. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i_afb146fda251b25c9fc812718f6c5b3e1}{$\sim$\+\_\+1wire\+\_\+i}} ()=default
|
|
\begin{DoxyCompactList}\small\item\em Allow destructor from derived only. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i_adc539ccd0e41f8f830bd96c362094c14}{\+\_\+1wire\+\_\+i}} (const \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} \&)=delete
|
|
\begin{DoxyCompactList}\small\item\em No copies. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} \& \mbox{\hyperlink{classutl_1_1__1wire__i_a96222b5bd731c2b242e428aabda40642}{operator=}} (const \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} \&)=delete
|
|
\end{DoxyCompactItemize}
|
|
\end{Indent}
|
|
\subsection*{Friends api to provide functionality to all class specializations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_aedee6f129425833a172784ec3c6e21e9}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch}} (\+\_\+T \&, \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}}, typename \+\_\+\+T\+::\+Speed)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{classutl_1_1__1wire__i_a6deca63bf5935ba3c3aa07f6ca23e33a}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match}} (\+\_\+T \&obj, \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id, typename \+\_\+\+T\+::\+Speed s)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{classutl_1_1__1wire__i_a6b70d3457970aa791dd68e20800b6d0d}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr}} (\+\_\+T \&obj, \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{classutl_1_1__1wire__i_a9041b1220dfa52b4f4b161b718c3d33a}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip}} (\+\_\+T \&obj, typename \+\_\+\+T\+::\+Speed s)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{classutl_1_1__1wire__i_af4dfbd90b0d5606f1f2e515d38a43d66}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr}} (\+\_\+T \&obj)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_a05f0872f43d7b305269904d1522fa437}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first}} (\+\_\+T \&, typename \+\_\+\+T\+::\+Speed, bool)
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i_af9a6a28b49cd3f51736f7c1f8e67327a}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next}} (\+\_\+T \&, typename \+\_\+\+T\+::\+Speed, bool)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$typename impl\+\_\+t$>$\newline
|
|
class utl\+::\+\_\+1wire\+\_\+i$<$ impl\+\_\+t $>$}
|
|
|
|
Template base class for 1-\/wire communication interface using C\+R\+TP.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em impl\+\_\+t} & The C\+R\+TP type (the derived/implementation class typename). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line 57 of file \+\_\+1wire.\+h.
|
|
|
|
|
|
|
|
\subsection{Member Typedef Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_afb63e64403924897a8277eb4159ebd44}\label{classutl_1_1__1wire__i_afb63e64403924897a8277eb4159ebd44}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!type@{type}}
|
|
\index{type@{type}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{type}{type}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__i_afb63e64403924897a8277eb4159ebd44}{type}} = \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}}
|
|
|
|
|
|
|
|
Export type as identity meta-\/function.
|
|
|
|
|
|
|
|
Definition at line 61 of file \+\_\+1wire.\+h.
|
|
|
|
|
|
|
|
\subsection{Member Enumeration Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}\label{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!Speed@{Speed}}
|
|
\index{Speed@{Speed}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{Speed}{Speed}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
enum \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{utl\+::\+\_\+1wire\+\_\+i\+::\+Speed}}\hspace{0.3cm}{\ttfamily [strong]}}
|
|
|
|
|
|
|
|
1-\/wire bus speed
|
|
|
|
\begin{DoxyEnumFields}{Enumerator}
|
|
\raisebox{\heightof{T}}[0pt][0pt]{\index{S\+TD@{S\+TD}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!S\+TD@{S\+TD}}}\mbox{\Hypertarget{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}\label{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}}
|
|
S\+TD&\\
|
|
\hline
|
|
|
|
\raisebox{\heightof{T}}[0pt][0pt]{\index{O\+V\+DR@{O\+V\+DR}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!O\+V\+DR@{O\+V\+DR}}}\mbox{\Hypertarget{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cca1cbf38b04c4249d8ec27d1ec96aaff68}\label{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cca1cbf38b04c4249d8ec27d1ec96aaff68}}
|
|
O\+V\+DR&\\
|
|
\hline
|
|
|
|
\end{DoxyEnumFields}
|
|
|
|
|
|
Definition at line 64 of file \+\_\+1wire.\+h.
|
|
|
|
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a4839577d00fdcefb51ac8d4cd91f0f1a}\label{classutl_1_1__1wire__i_a4839577d00fdcefb51ac8d4cd91f0f1a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i@{\+\_\+1wire\+\_\+i}}
|
|
\index{\+\_\+1wire\+\_\+i@{\+\_\+1wire\+\_\+i}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i()}{\_1wire\_i()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
|
|
|
|
|
|
|
|
Allow constructor from derived only.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_afb146fda251b25c9fc812718f6c5b3e1}\label{classutl_1_1__1wire__i_afb146fda251b25c9fc812718f6c5b3e1}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!````~\+\_\+1wire\+\_\+i@{$\sim$\+\_\+1wire\+\_\+i}}
|
|
\index{````~\+\_\+1wire\+\_\+i@{$\sim$\+\_\+1wire\+\_\+i}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{$\sim$\+\_\+1wire\+\_\+i()}{~\_1wire\_i()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::$\sim$\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
|
|
|
|
|
|
|
|
Allow destructor from derived only.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_adc539ccd0e41f8f830bd96c362094c14}\label{classutl_1_1__1wire__i_adc539ccd0e41f8f830bd96c362094c14}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i@{\+\_\+1wire\+\_\+i}}
|
|
\index{\+\_\+1wire\+\_\+i@{\+\_\+1wire\+\_\+i}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i()}{\_1wire\_i()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}} (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$ \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}
|
|
|
|
|
|
|
|
No copies.
|
|
|
|
|
|
|
|
\subsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a4b6d225963095d36eda832a1e0adba55}\label{classutl_1_1__1wire__i_a4b6d225963095d36eda832a1e0adba55}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!first@{first}}
|
|
\index{first@{first}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{first()}{first()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::first (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}}, }\item[{bool}]{alarm = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
\textquotesingle{}first\textquotesingle{} operation, to search on the 1-\/\+Wire for the first device. This is performed by setting dec\+\_\+, pos\+\_\+ and cur\+\_\+ to zero and then doing the search.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em s} & The bus speed \\
|
|
\hline
|
|
{\em alarm} & If set, search for alarm devices \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
ID The rom\+ID \begin{DoxyItemize}
|
|
\item null\+Dev Indicate no \mbox{[}more\mbox{]} device\mbox{[}s\mbox{]} \end{DoxyItemize}
|
|
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 207 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_aa2d87a149c4e5dcfefc5a8cde6eaefb2}\label{classutl_1_1__1wire__i_aa2d87a149c4e5dcfefc5a8cde6eaefb2}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!match@{match}}
|
|
\index{match@{match}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{match()}{match()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::match (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Send match rom command
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em id} & The ID to select on the bus \\
|
|
\hline
|
|
{\em s} & The speed to use for the command \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line 173 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_ac88f67dd75dc23d39123ac584dce6b40}\label{classutl_1_1__1wire__i_ac88f67dd75dc23d39123ac584dce6b40}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!match\+\_\+n\+\_\+ovdr@{match\+\_\+n\+\_\+ovdr}}
|
|
\index{match\+\_\+n\+\_\+ovdr@{match\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{match\+\_\+n\+\_\+ovdr()}{match\_n\_ovdr()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::match\+\_\+n\+\_\+ovdr (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Match and overdrive sequence
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em obj} & The object from which we call private members \\
|
|
\hline
|
|
{\em id} & The ID to select on the bus \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line 181 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a3e302085f12a39fef8a378e1dac42f45}\label{classutl_1_1__1wire__i_a3e302085f12a39fef8a378e1dac42f45}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!next@{next}}
|
|
\index{next@{next}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{next()}{next()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::next (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}}, }\item[{bool}]{alarm = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
\textquotesingle{}next\textquotesingle{} operation, to search on the 1-\/\+Wire for the next device. This search is usually performed after a \textquotesingle{}first\textquotesingle{} operation or another \textquotesingle{}next\textquotesingle{} operation. Based on maxim-\/ic application note 187.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em s} & The bus speed \\
|
|
\hline
|
|
{\em alarm} & If set, search for alarm devices \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
ID The rom\+ID \begin{DoxyItemize}
|
|
\item null\+Dev Indicate no \mbox{[}more\mbox{]} device\mbox{[}s\mbox{]} \end{DoxyItemize}
|
|
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 220 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a96222b5bd731c2b242e428aabda40642}\label{classutl_1_1__1wire__i_a96222b5bd731c2b242e428aabda40642}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!operator=@{operator=}}
|
|
\index{operator=@{operator=}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{operator=()}{operator=()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}\& \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::operator= (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1__1wire__i}{\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$ \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a0a7ef731162e81e0e2e07ae9cb9e6ffa}\label{classutl_1_1__1wire__i_a0a7ef731162e81e0e2e07ae9cb9e6ffa}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!reset@{reset}}
|
|
\index{reset@{reset}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{reset()}{reset()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
bool \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::reset (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Generate a 1-\/wire reset.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em s} & Bus speed \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The status of the operation \begin{DoxyItemize}
|
|
\item 0 Fail \item 1 Success \end{DoxyItemize}
|
|
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 128 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a2585e7166d14b7f36bd47db2e43cc0b1}\label{classutl_1_1__1wire__i_a2585e7166d14b7f36bd47db2e43cc0b1}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!rx\+\_\+data@{rx\+\_\+data}}
|
|
\index{rx\+\_\+data@{rx\+\_\+data}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{rx\+\_\+data()}{rx\_data()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::rx\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Receive a byte from 1-\/\+Wire bus while transmitting 0x\+FF
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em s} & Bus speed to use \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The byte received.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 156 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_ad20382d5d50ee7d457bc4079b9c38a2a}\label{classutl_1_1__1wire__i_ad20382d5d50ee7d457bc4079b9c38a2a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!rx\+\_\+data@{rx\+\_\+data}}
|
|
\index{rx\+\_\+data@{rx\+\_\+data}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{rx\+\_\+data()}{rx\_data()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename \+\_\+I $>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ \+\_\+I $>$\+::rx\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$}]{in, }\item[{\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}}}]{n, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})}
|
|
|
|
Receive a number of bytes from 1-\/wire bus while transmitting 0x\+F\+Fs
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em in} & Pointer to data to store \\
|
|
\hline
|
|
{\em n} & Number of bytes \\
|
|
\hline
|
|
{\em s} & Speed to use \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The number of transmitted bytes
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 248 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a0a405f818fd45eb2799e6b4477021a0a}\label{classutl_1_1__1wire__i_a0a405f818fd45eb2799e6b4477021a0a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!skip@{skip}}
|
|
\index{skip@{skip}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{skip()}{skip()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::skip (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Send skip command to the bus
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em id} & The ID to select on the bus \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line 188 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a8b0b0ea95c02a40721f1e159119b3506}\label{classutl_1_1__1wire__i_a8b0b0ea95c02a40721f1e159119b3506}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!skip\+\_\+n\+\_\+ovdr@{skip\+\_\+n\+\_\+ovdr}}
|
|
\index{skip\+\_\+n\+\_\+ovdr@{skip\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{skip\+\_\+n\+\_\+ovdr()}{skip\_n\_ovdr()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
void \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::skip\+\_\+n\+\_\+ovdr (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Send the Skip and Overdrive sequence
|
|
|
|
Definition at line 194 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a59e7196e10e53467b62ed369ff78f07d}\label{classutl_1_1__1wire__i_a59e7196e10e53467b62ed369ff78f07d}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!tx\+\_\+data@{tx\+\_\+data}}
|
|
\index{tx\+\_\+data@{tx\+\_\+data}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{tx\+\_\+data()}{tx\_data()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ impl\+\_\+t $>$\+::tx\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}}}]{out, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Transmit a byte to 1-\/\+Wire bus and read the response
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em out} & The byte to write \\
|
|
\hline
|
|
{\em s} & Bus speed to use \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The byte received.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 138 of file \+\_\+1wire.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_ab3bd112ff66074bdaf7357b91ca692a8}\label{classutl_1_1__1wire__i_ab3bd112ff66074bdaf7357b91ca692a8}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!tx\+\_\+data@{tx\+\_\+data}}
|
|
\index{tx\+\_\+data@{tx\+\_\+data}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{tx\+\_\+data()}{tx\_data()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename \+\_\+I $>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1__1wire__i}{utl\+::\+\_\+1wire\+\_\+i}}$<$ \+\_\+I $>$\+::tx\+\_\+data (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$}]{out, }\item[{\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $\ast$}]{in, }\item[{\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}}}]{n, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25cc}{Speed}}}]{s = {\ttfamily \mbox{\hyperlink{classutl_1_1__1wire__i_a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7}{Speed\+::\+S\+TD}}} }\end{DoxyParamCaption})}
|
|
|
|
Transmit a number of bytes to 1-\/wire bus and read the response
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em out} & Pointer to data to transmit \\
|
|
\hline
|
|
{\em in} & Pointer to data to store \\
|
|
\hline
|
|
{\em n} & Number of bytes \\
|
|
\hline
|
|
{\em s} & Speed to use \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The number of transmitted bytes
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 241 of file \+\_\+1wire.\+h.
|
|
|
|
|
|
|
|
\subsection{Friends And Related Function Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a05f0872f43d7b305269904d1522fa437}\label{classutl_1_1__1wire__i_a05f0872f43d7b305269904d1522fa437}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first}{\_1wire\_i\_det::\_first}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a237719ffa105f988cb175d6720712a4a}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{, }\item[{typename \+\_\+\+T\+::\+Speed}]{, }\item[{bool}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a6deca63bf5935ba3c3aa07f6ca23e33a}\label{classutl_1_1__1wire__i_a6deca63bf5935ba3c3aa07f6ca23e33a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match}{\_1wire\_i\_det::\_match}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1b07e623a39ce82f1514846169f3a954}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id, }\item[{typename \+\_\+\+T\+::\+Speed}]{s }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a6b70d3457970aa791dd68e20800b6d0d}\label{classutl_1_1__1wire__i_a6b70d3457970aa791dd68e20800b6d0d}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr}{\_1wire\_i\_det::\_match\_n\_ovdr}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1e14f734d5e232c914be6ea97982aa40}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj, }\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_af9a6a28b49cd3f51736f7c1f8e67327a}\label{classutl_1_1__1wire__i_af9a6a28b49cd3f51736f7c1f8e67327a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next}{\_1wire\_i\_det::\_next}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1f7b692a40769ebe59343613b147e01d}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{, }\item[{typename \+\_\+\+T\+::\+Speed}]{, }\item[{bool}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_a9041b1220dfa52b4f4b161b718c3d33a}\label{classutl_1_1__1wire__i_a9041b1220dfa52b4f4b161b718c3d33a}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip}{\_1wire\_i\_det::\_skip}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a9ea80f4ef2422a7fd71788c42b228053}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj, }\item[{typename \+\_\+\+T\+::\+Speed}]{s }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_af4dfbd90b0d5606f1f2e515d38a43d66}\label{classutl_1_1__1wire__i_af4dfbd90b0d5606f1f2e515d38a43d66}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr}{\_1wire\_i\_det::\_skip\_n\_ovdr}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_ace224a4d329166bfd9f3448e492baf2b}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__i_aedee6f129425833a172784ec3c6e21e9}\label{classutl_1_1__1wire__i_aedee6f129425833a172784ec3c6e21e9}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}!\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch}}
|
|
\index{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch@{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch}!utl\+::\+\_\+1wire\+\_\+i@{utl\+::\+\_\+1wire\+\_\+i}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch}{\_1wire\_i\_det::\_touch}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t$>$ \\
|
|
template$<$typename \+\_\+T $>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a85a3a19778edb037f6341f37135a5494}{\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch}} (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{, }\item[{\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}}}]{, }\item[{typename \+\_\+\+T\+::\+Speed}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
include/utl/com/\mbox{\hyperlink{__1wire_8h}{\+\_\+1wire.\+h}}\end{DoxyCompactItemize}
|