Micro template library A library for building device drivers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

classutl_1_1__1wire__id__t.tex 9.1 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. \hypertarget{classutl_1_1__1wire__id__t}{}\section{utl\+:\+:\+\_\+1wire\+\_\+id\+\_\+t Class Reference}
  2. \label{classutl_1_1__1wire__id__t}\index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  3. {\ttfamily \#include $<$\+\_\+1wire\+\_\+id.\+h$>$}
  4. Inheritance diagram for utl\+:\+:\+\_\+1wire\+\_\+id\+\_\+t\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=2.000000cm]{classutl_1_1__1wire__id__t}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{Indent}\textbf{ Constructors}\par
  12. \begin{DoxyCompactItemize}
  13. \item
  14. \mbox{\hyperlink{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}{\+\_\+1wire\+\_\+id\+\_\+t}} () noexcept
  15. \item
  16. \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
  17. \end{DoxyCompactItemize}
  18. \end{Indent}
  19. \textbf{ }\par
  20. \begin{DoxyCompactItemize}
  21. \item
  22. uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}{crc8}} () noexcept
  23. \item
  24. const uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}{crc8}} () const noexcept
  25. \end{DoxyCompactItemize}
  26. \subsection*{Static Public Member Functions}
  27. \begin{DoxyCompactItemize}
  28. \item
  29. 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
  30. \begin{DoxyCompactList}\small\item\em Full compare two dev\+\_\+ids. \end{DoxyCompactList}\end{DoxyCompactItemize}
  31. \subsection*{User functionality provided by the interface}
  32. \begin{DoxyCompactItemize}
  33. \item
  34. uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}{family}} () noexcept
  35. \item
  36. const uint8\+\_\+t \& \mbox{\hyperlink{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}{family}} () const noexcept
  37. \item
  38. 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}} ()
  39. \begin{DoxyCompactList}\small\item\em Return null\+Dev reference. \end{DoxyCompactList}\end{DoxyCompactItemize}
  40. \subsection*{Additional Inherited Members}
  41. \subsection{Detailed Description}
  42. 1-\/wire Rom-\/\+ID type
  43. Definition at line 32 of file \+\_\+1wire\+\_\+id.\+h.
  44. \subsection{Constructor \& Destructor Documentation}
  45. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}\label{classutl_1_1__1wire__id__t_a813f69adfff7bcdcba6b07bf52e3546e}}
  46. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}}
  47. \index{\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  48. \subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+id\+\_\+t()}{\_1wire\_id\_t()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
  49. {\footnotesize\ttfamily utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::\+\_\+1wire\+\_\+id\+\_\+t (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
  50. Definition at line 39 of file \+\_\+1wire\+\_\+id.\+h.
  51. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_a042aa65cc13c6040f795c8198f5afc23}\label{classutl_1_1__1wire__id__t_a042aa65cc13c6040f795c8198f5afc23}}
  52. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}}
  53. \index{\+\_\+1wire\+\_\+id\+\_\+t@{\+\_\+1wire\+\_\+id\+\_\+t}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  54. \subsubsection{\texorpdfstring{\+\_\+1wire\+\_\+id\+\_\+t()}{\_1wire\_id\_t()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
  55. {\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]}}
  56. Definition at line 41 of file \+\_\+1wire\+\_\+id.\+h.
  57. \subsection{Member Function Documentation}
  58. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_aef89950aeb9d40ca058fabcc5532e01d}\label{classutl_1_1__1wire__id__t_aef89950aeb9d40ca058fabcc5532e01d}}
  59. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!compare@{compare}}
  60. \index{compare@{compare}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  61. \subsubsection{\texorpdfstring{compare()}{compare()}}
  62. {\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]}}
  63. Full compare two dev\+\_\+ids.
  64. \begin{DoxyReturn}{Returns}
  65. The comparison result \begin{DoxyItemize}
  66. \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}
  67. \end{DoxyReturn}
  68. Definition at line 72 of file \+\_\+1wire\+\_\+id.\+h.
  69. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}\label{classutl_1_1__1wire__id__t_a03a112d8910c67611a3b302fe7c0706b}}
  70. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!crc8@{crc8}}
  71. \index{crc8@{crc8}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  72. \subsubsection{\texorpdfstring{crc8()}{crc8()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
  73. {\footnotesize\ttfamily uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::crc8 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
  74. Access the C\+R\+C8 byte (The M\+SB).
  75. Definition at line 60 of file \+\_\+1wire\+\_\+id.\+h.
  76. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}\label{classutl_1_1__1wire__id__t_af3a0ea2c575f96ac01b0aac91166d767}}
  77. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!crc8@{crc8}}
  78. \index{crc8@{crc8}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  79. \subsubsection{\texorpdfstring{crc8()}{crc8()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
  80. {\footnotesize\ttfamily const uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::crc8 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
  81. Definition at line 61 of file \+\_\+1wire\+\_\+id.\+h.
  82. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}\label{classutl_1_1__1wire__id__t_adb30b65bcab59bdad980793377a8e52f}}
  83. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!family@{family}}
  84. \index{family@{family}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  85. \subsubsection{\texorpdfstring{family()}{family()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
  86. {\footnotesize\ttfamily uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::family (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
  87. Return the Rom\+ID family code (The L\+SB)
  88. Definition at line 54 of file \+\_\+1wire\+\_\+id.\+h.
  89. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}\label{classutl_1_1__1wire__id__t_a6ed0d86d1fce0073776d83092a874b91}}
  90. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!family@{family}}
  91. \index{family@{family}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  92. \subsubsection{\texorpdfstring{family()}{family()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
  93. {\footnotesize\ttfamily const uint8\+\_\+t\& utl\+::\+\_\+1wire\+\_\+id\+\_\+t\+::family (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
  94. Definition at line 55 of file \+\_\+1wire\+\_\+id.\+h.
  95. \mbox{\Hypertarget{classutl_1_1__1wire__id__t_adad08aa5ce38e1a87800de57a91db81b}\label{classutl_1_1__1wire__id__t_adad08aa5ce38e1a87800de57a91db81b}}
  96. \index{utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}!null\+Dev@{null\+Dev}}
  97. \index{null\+Dev@{null\+Dev}!utl\+::\+\_\+1wire\+\_\+id\+\_\+t@{utl\+::\+\_\+1wire\+\_\+id\+\_\+t}}
  98. \subsubsection{\texorpdfstring{null\+Dev()}{nullDev()}}
  99. {\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]}}
  100. Return null\+Dev reference.
  101. Definition at line 50 of file \+\_\+1wire\+\_\+id.\+h.
  102. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  103. \item
  104. include/utl/com/\mbox{\hyperlink{__1wire__id_8h}{\+\_\+1wire\+\_\+id.\+h}}\end{DoxyCompactItemize}