156 lines
9.1 KiB
TeX
156 lines
9.1 KiB
TeX
\hypertarget{classutl_1_1__1wire__id__t}{}\section{utl\+:\+:\+\_\+1wire\+\_\+id\+\_\+t Class Reference}
|
|
\label{classutl_1_1__1wire__id__t}\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
|
|
|
|
{\ttfamily \#include $<$\+\_\+1wire\+\_\+id.\+h$>$}
|
|
|
|
Inheritance diagram for utl\+:\+:\+\_\+1wire\+\_\+id\+\_\+t\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.000000cm]{classutl_1_1__1wire__id__t}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{Indent}\textbf{ Constructors}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}{\+\_\+1wire\+\_\+id\+\_\+t}} () noexcept
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1__1wire__id__t_a042aa65cc13c6040f795c8198f5afc23}{\+\_\+1wire\+\_\+id\+\_\+t}} (const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id) noexcept
|
|
\end{DoxyCompactItemize}
|
|
\end{Indent}
|
|
\textbf{ }\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}{crc8}} () noexcept
|
|
\item
|
|
const uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}{crc8}} () const noexcept
|
|
\end{DoxyCompactItemize}
|
|
|
|
\subsection*{Static Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
static int \mbox{\hyperlink{classutl_1_1__1wire__id__t_aef89950aeb9d40ca058fabcc5532e01d}{compare}} (const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&lhs, const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&rhs) noexcept
|
|
\begin{DoxyCompactList}\small\item\em Full compare two dev\+\_\+ids. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\subsection*{User functionality provided by the interface}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}{family}} () noexcept
|
|
\item
|
|
const uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}{family}} () const noexcept
|
|
\item
|
|
static constexpr const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_adad08aa5ce38e1a87800de57a91db81b}{null\+Dev}} ()
|
|
\begin{DoxyCompactList}\small\item\em Return null\+Dev reference. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\subsection*{Additional Inherited Members}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
1-\/wire Rom-\/\+ID type
|
|
|
|
Definition at line 32 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}\label{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\index{\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+id\+\_\+t()}{\_1wire\_id\_t()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::\+\_\+1wire\+\_\+id\+\_\+t (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 39 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_a042aa65cc13c6040f795c8198f5afc23}\label{classutl_1_1__1wire__id__t_a042aa65cc13c6040f795c8198f5afc23}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\index{\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+id\+\_\+t()}{\_1wire\_id\_t()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::\+\_\+1wire\+\_\+id\+\_\+t (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 41 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
|
|
|
|
\subsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_aef89950aeb9d40ca058fabcc5532e01d}\label{classutl_1_1__1wire__id__t_aef89950aeb9d40ca058fabcc5532e01d}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!compare@{compare}}
|
|
\index{compare@{compare}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{compare()}{compare()}}
|
|
{\footnotesize\ttfamily static int utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::compare (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{lhs, }\item[{const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{rhs }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Full compare two dev\+\_\+ids.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
The comparison result \begin{DoxyItemize}
|
|
\item 0 dev\+\_\+ids are equal \item -\/1 dev\+\_\+id lhs is smaller than dev\+\_\+id rhs \item 1 dev\+\_\+id rhs is smaller than dev\+\_\+id lhs \end{DoxyItemize}
|
|
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 72 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}\label{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!crc8@{crc8}}
|
|
\index{crc8@{crc8}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{crc8()}{crc8()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::crc8 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
Access the C\+R\+C8 byte (The M\+SB).
|
|
|
|
Definition at line 60 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}\label{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!crc8@{crc8}}
|
|
\index{crc8@{crc8}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{crc8()}{crc8()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily const uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::crc8 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 61 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}\label{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!family@{family}}
|
|
\index{family@{family}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{family()}{family()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::family (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
Return the Rom\+ID family code (The L\+SB)
|
|
|
|
Definition at line 54 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}\label{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!family@{family}}
|
|
\index{family@{family}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{family()}{family()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily const uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::family (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 55 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1__1wire__id__t_adad08aa5ce38e1a87800de57a91db81b}\label{classutl_1_1__1wire__id__t_adad08aa5ce38e1a87800de57a91db81b}}
|
|
\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!null\+Dev@{null\+Dev}}
|
|
\index{null\+Dev@{null\+Dev}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
|
|
\subsubsection{\texorpdfstring{null\+Dev()}{nullDev()}}
|
|
{\footnotesize\ttfamily static constexpr const \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}}\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::null\+Dev (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}
|
|
|
|
|
|
|
|
Return null\+Dev reference.
|
|
|
|
|
|
|
|
Definition at line 50 of file \+\_\+1wire\+\_\+id.\+h.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
include/utl/com/\mbox{\hyperlink{__1wire__id_8h}{\+\_\+1wire\+\_\+id.\+h}}\end{DoxyCompactItemize}
|