hoo2
/
utl
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
48 Commits
3 Branches
5.6 MiB
 
 
 
 
Tree: bebb193278
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bebb193278'
${ noResults }
utl/doc/latex/classutl_1_1in__dev.tex

408 lines
25 KiB
Raw Blame History 

  1. \hypertarget{classutl_1_1in__dev}{}\section{utl\+:\+:in\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$ Class Template Reference}

  2. \label{classutl_1_1in__dev}\index{utl\+::in\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$@{utl\+::in\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$}}

  3. 

  4. 

  5. Abstract base class for input devices.  

  6. 

  7. 

  8. 

  9. 

  10. {\ttfamily \#include $<$in\+\_\+dev.\+h$>$}

  11. 

  12. \subsection*{Public Types}

  13. \begin{DoxyCompactItemize}

  14. \item 

  15. using \mbox{\hyperlink{classutl_1_1in__dev_adef54df1c3d4ae20629ecfdb7826384c}{type}} = \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}

  16. \begin{DoxyCompactList}\small\item\em Export type as identity meta-\/function. \end{DoxyCompactList}\end{DoxyCompactItemize}

  17. \textbf{ }\par

  18. \begin{DoxyCompactItemize}

  19. \item 

  20. using \mbox{\hyperlink{classutl_1_1in__dev_acb38742b242e8cf90323d46a9907863d}{data\+\_\+type}} = data\+\_\+t

  21. \item 

  22. using \mbox{\hyperlink{classutl_1_1in__dev_aef4b5c41ab91ef284cfc0cf6100c0828}{pointer\+\_\+type}} = data\+\_\+t $\ast$

  23. \end{DoxyCompactItemize}

  24. 

  25. \subsection*{Public Member Functions}

  26. \begin{Indent}\textbf{ Public Get interface}\par

  27. \begin{DoxyCompactItemize}

  28. \item 

  29. \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1in__dev_aa13a075d41f3e020f4f67c2a59d580a5}{get}} (data\+\_\+t \&data)

  30. \begin{DoxyCompactList}\small\item\em Get interface. This function should read a single data\+\_\+t object from device in blocking mode. \end{DoxyCompactList}\item 

  31. \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1in__dev_a5536fdd877bc9f078a9ede43ccc283e7}{get}} (data\+\_\+t $\ast$data, \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} n)

  32. \begin{DoxyCompactList}\small\item\em Old stile get functionality using free standing data\+\_\+t$\ast$. This function should return a stream of data from device. \end{DoxyCompactList}\end{DoxyCompactItemize}

  33. \end{Indent}

  34. \begin{Indent}\textbf{ Stream operator $>$$>$ interface}\par

  35. \begin{DoxyCompactItemize}

  36. \item 

  37. {\footnotesize template$<$typename \+\_\+\+Dst\+\_\+t $>$ }\\\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1in__dev_abe8aa85c0dbe0ddb3745ded02b4e68fe}{operator$>$$>$}} (\+\_\+\+Dst\+\_\+t \&dst)

  38. \begin{DoxyCompactList}\small\item\em Template operator $>$$>$ implementation for for all by value/ref parameters. \end{DoxyCompactList}\item 

  39. {\footnotesize template$<$typename \+\_\+\+Dst\+\_\+t $>$ }\\\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1in__dev_a60b3bba96e6bfd2091e594fdbc93fd6f}{operator$>$$>$}} (\+\_\+\+Dst\+\_\+t $\ast$dst)=delete

  40. \begin{DoxyCompactList}\small\item\em Specialization to disallow pointer types as destination. \end{DoxyCompactList}\item 

  41. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1in__dev_a98774619e8575162a8be271833282690}{operator$>$$>$}} (data\+\_\+t \&dst)

  42. \begin{DoxyCompactList}\small\item\em Overload for single data\+\_\+t object. \end{DoxyCompactList}\end{DoxyCompactItemize}

  43. \end{Indent}

  44. \textbf{ }\par

  45. \begin{DoxyCompactItemize}

  46. \item 

  47. \mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} \mbox{\hyperlink{classutl_1_1in__dev_aae7797f366d25091b63ad87b34ed4b48}{end}} () noexcept

  48. \item 

  49. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev_aecb438cbb0e2a6c3a926aad81e8c29c7}{end}} () const noexcept

  50. \item 

  51. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev_ac54d9a1fb6241be460ffc792aac18b24}{cend}} () const noexcept

  52. \end{DoxyCompactItemize}

  53. 

  54. \subsection*{Protected Member Functions}

  55. \begin{Indent}\textbf{ Constructor / Destructor}\par

  56. \begin{DoxyCompactItemize}

  57. \item 

  58. \mbox{\hyperlink{classutl_1_1in__dev_a2caa0f47e6132f051bb54b1acea37fc6}{$\sim$in\+\_\+dev}} ()=default

  59. \begin{DoxyCompactList}\small\item\em Allow destructor from derived only. \end{DoxyCompactList}\item 

  60. \mbox{\hyperlink{classutl_1_1in__dev_a1ca16c382f5e0dd25089a4e06a40f2f2}{in\+\_\+dev}} ()=default

  61. \begin{DoxyCompactList}\small\item\em A default constructor from derived only. \end{DoxyCompactList}\item 

  62. \mbox{\hyperlink{classutl_1_1in__dev_a570c94b183eff6f8ca2d7d9ab5d9a7ea}{in\+\_\+dev}} (const \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \&)=delete

  63. \begin{DoxyCompactList}\small\item\em No copies. \end{DoxyCompactList}\item 

  64. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1in__dev_a55dc56f1277b2bd04b154fbf19d8853f}{operator=}} (const \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \&)=delete

  65. \end{DoxyCompactItemize}

  66. \end{Indent}

  67. \subsection*{S\+T\+L-\/like Input iterator interface}

  68. \begin{DoxyCompactItemize}

  69. \item 

  70. using \mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}}$<$ \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}, data\+\_\+t $\ast$, streamsize $>$

  71. \begin{DoxyCompactList}\small\item\em Iterator. \end{DoxyCompactList}\item 

  72. using \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}}$<$ \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}, const data\+\_\+t $\ast$, streamsize $>$

  73. \begin{DoxyCompactList}\small\item\em Const iterator. \end{DoxyCompactList}\item 

  74. \mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} \mbox{\hyperlink{classutl_1_1in__dev_ab2158d8a134dff882a3eac2960da04c0}{begin}} () noexcept

  75. \begin{DoxyCompactList}\small\item\em .begin implementation \end{DoxyCompactList}\item 

  76. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev_af81ff90ccb0070ad9388bc032d6d3279}{begin}} () const noexcept

  77. \item 

  78. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev_a1120a80c871e1ea8165b4943c767893d}{cbegin}} () const noexcept

  79. \end{DoxyCompactItemize}

  80. 

  81. 

  82. \subsection{Detailed Description}

  83. \subsubsection*{template$<$typename impl\+\_\+t, typename data\+\_\+t, size\+\_\+t streamsize = 0$>$\newline

  84. class utl\+::in\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$}

  85. 

  86. Abstract base class for input devices. 

  87. 

  88. Template base class for un-\/buffered input devices. using C\+R\+TP

  89. 

  90. This class force a common interface for input, non-\/buffered devices. By using this common interface the class implements

  91. \begin{DoxyItemize}

  92. \item Stream-\/like extracting operator

  93. \item Input iterator

  94. \item Const input iterator to inherit to implementation.

  95. \end{DoxyItemize}

  96. 

  97. 

  98. \begin{DoxyParams}{Parameters}

  99. {\em impl\+\_\+t} & The C\+R\+TP type (the derived/implementation class typename). \\

  100. \hline

  101. {\em data\+\_\+t} & The devices base type of data \\

  102. \hline

  103. {\em streamsize} & The number of elements to indicate eos. \begin{DoxyItemize}

  104. \item None or 0 Stream only. No iterator as \mbox{\hyperlink{classutl_1_1in__dev_ab2158d8a134dff882a3eac2960da04c0}{begin()}} now equals \mbox{\hyperlink{classutl_1_1in__dev_aae7797f366d25091b63ad87b34ed4b48}{end()}}. \end{DoxyItemize}

  105. \\

  106. \hline

  107. \end{DoxyParams}

  108. 

  109. 

  110. Definition at line 54 of file in\+\_\+dev.\+h.

  111. 

  112. 

  113. 

  114. \subsection{Member Typedef Documentation}

  115. \mbox{\Hypertarget{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}\label{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}} 

  116. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!const\+\_\+iterator@{const\+\_\+iterator}}

  117. \index{const\+\_\+iterator@{const\+\_\+iterator}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  118. \subsubsection{\texorpdfstring{const\+\_\+iterator}{const\_iterator}}

  119. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  120. using \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} =  \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}} $<$\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}, const data\+\_\+t$\ast$, streamsize$>$}

  121. 

  122. 

  123. 

  124. Const iterator. 

  125. 

  126. 

  127. 

  128. Definition at line 151 of file in\+\_\+dev.\+h.

  129. 

  130. \mbox{\Hypertarget{classutl_1_1in__dev_acb38742b242e8cf90323d46a9907863d}\label{classutl_1_1in__dev_acb38742b242e8cf90323d46a9907863d}} 

  131. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!data\+\_\+type@{data\+\_\+type}}

  132. \index{data\+\_\+type@{data\+\_\+type}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  133. \subsubsection{\texorpdfstring{data\+\_\+type}{data\_type}}

  134. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  135. using \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev_acb38742b242e8cf90323d46a9907863d}{data\+\_\+type}} =  data\+\_\+t}

  136. 

  137. Export types as input device concept demands 

  138. 

  139. Definition at line 61 of file in\+\_\+dev.\+h.

  140. 

  141. \mbox{\Hypertarget{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}\label{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}} 

  142. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!iterator@{iterator}}

  143. \index{iterator@{iterator}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  144. \subsubsection{\texorpdfstring{iterator}{iterator}}

  145. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  146. using \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} =  \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}} $<$\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}, data\+\_\+t$\ast$, streamsize$>$}

  147. 

  148. 

  149. 

  150. Iterator. 

  151. 

  152. 

  153. 

  154. Definition at line 150 of file in\+\_\+dev.\+h.

  155. 

  156. \mbox{\Hypertarget{classutl_1_1in__dev_aef4b5c41ab91ef284cfc0cf6100c0828}\label{classutl_1_1in__dev_aef4b5c41ab91ef284cfc0cf6100c0828}} 

  157. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!pointer\+\_\+type@{pointer\+\_\+type}}

  158. \index{pointer\+\_\+type@{pointer\+\_\+type}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  159. \subsubsection{\texorpdfstring{pointer\+\_\+type}{pointer\_type}}

  160. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  161. using \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev_aef4b5c41ab91ef284cfc0cf6100c0828}{pointer\+\_\+type}} =  data\+\_\+t$\ast$}

  162. 

  163. 

  164. 

  165. Definition at line 62 of file in\+\_\+dev.\+h.

  166. 

  167. \mbox{\Hypertarget{classutl_1_1in__dev_adef54df1c3d4ae20629ecfdb7826384c}\label{classutl_1_1in__dev_adef54df1c3d4ae20629ecfdb7826384c}} 

  168. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!type@{type}}

  169. \index{type@{type}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  170. \subsubsection{\texorpdfstring{type}{type}}

  171. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  172. using \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev_adef54df1c3d4ae20629ecfdb7826384c}{type}} =  \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}}

  173. 

  174. 

  175. 

  176. Export type as identity meta-\/function. 

  177. 

  178. 

  179. 

  180. Definition at line 64 of file in\+\_\+dev.\+h.

  181. 

  182. 

  183. 

  184. \subsection{Constructor \& Destructor Documentation}

  185. \mbox{\Hypertarget{classutl_1_1in__dev_a2caa0f47e6132f051bb54b1acea37fc6}\label{classutl_1_1in__dev_a2caa0f47e6132f051bb54b1acea37fc6}} 

  186. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!````~in\+\_\+dev@{$\sim$in\+\_\+dev}}

  187. \index{````~in\+\_\+dev@{$\sim$in\+\_\+dev}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  188. \subsubsection{\texorpdfstring{$\sim$in\+\_\+dev()}{~in\_dev()}}

  189. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  190. \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::$\sim$\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}

  191. 

  192. 

  193. 

  194. Allow destructor from derived only. 

  195. 

  196. \mbox{\Hypertarget{classutl_1_1in__dev_a1ca16c382f5e0dd25089a4e06a40f2f2}\label{classutl_1_1in__dev_a1ca16c382f5e0dd25089a4e06a40f2f2}} 

  197. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!in\+\_\+dev@{in\+\_\+dev}}

  198. \index{in\+\_\+dev@{in\+\_\+dev}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  199. \subsubsection{\texorpdfstring{in\+\_\+dev()}{in\_dev()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}

  200. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  201. \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}

  202. 

  203. 

  204. 

  205. A default constructor from derived only. 

  206. 

  207. \mbox{\Hypertarget{classutl_1_1in__dev_a570c94b183eff6f8ca2d7d9ab5d9a7ea}\label{classutl_1_1in__dev_a570c94b183eff6f8ca2d7d9ab5d9a7ea}} 

  208. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!in\+\_\+dev@{in\+\_\+dev}}

  209. \index{in\+\_\+dev@{in\+\_\+dev}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  210. \subsubsection{\texorpdfstring{in\+\_\+dev()}{in\_dev()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}

  211. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  212. \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev}} (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}

  213. 

  214. 

  215. 

  216. No copies. 

  217. 

  218. 

  219. 

  220. \subsection{Member Function Documentation}

  221. \mbox{\Hypertarget{classutl_1_1in__dev_ab2158d8a134dff882a3eac2960da04c0}\label{classutl_1_1in__dev_ab2158d8a134dff882a3eac2960da04c0}} 

  222. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!begin@{begin}}

  223. \index{begin@{begin}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  224. \subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}

  225. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  226. \mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::begin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  227. 

  228. 

  229. 

  230. .begin implementation 

  231. 

  232. 

  233. 

  234. Definition at line 154 of file in\+\_\+dev.\+h.

  235. 

  236. \mbox{\Hypertarget{classutl_1_1in__dev_af81ff90ccb0070ad9388bc032d6d3279}\label{classutl_1_1in__dev_af81ff90ccb0070ad9388bc032d6d3279}} 

  237. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!begin@{begin}}

  238. \index{begin@{begin}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  239. \subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}

  240. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  241. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::begin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  242. 

  243. 

  244. 

  245. Definition at line 155 of file in\+\_\+dev.\+h.

  246. 

  247. \mbox{\Hypertarget{classutl_1_1in__dev_a1120a80c871e1ea8165b4943c767893d}\label{classutl_1_1in__dev_a1120a80c871e1ea8165b4943c767893d}} 

  248. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!cbegin@{cbegin}}

  249. \index{cbegin@{cbegin}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  250. \subsubsection{\texorpdfstring{cbegin()}{cbegin()}}

  251. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  252. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::cbegin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  253. 

  254. 

  255. 

  256. Definition at line 156 of file in\+\_\+dev.\+h.

  257. 

  258. \mbox{\Hypertarget{classutl_1_1in__dev_ac54d9a1fb6241be460ffc792aac18b24}\label{classutl_1_1in__dev_ac54d9a1fb6241be460ffc792aac18b24}} 

  259. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!cend@{cend}}

  260. \index{cend@{cend}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  261. \subsubsection{\texorpdfstring{cend()}{cend()}}

  262. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  263. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::cend (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  264. 

  265. 

  266. 

  267. Definition at line 161 of file in\+\_\+dev.\+h.

  268. 

  269. \mbox{\Hypertarget{classutl_1_1in__dev_aae7797f366d25091b63ad87b34ed4b48}\label{classutl_1_1in__dev_aae7797f366d25091b63ad87b34ed4b48}} 

  270. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!end@{end}}

  271. \index{end@{end}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  272. \subsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}

  273. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  274. \mbox{\hyperlink{classutl_1_1in__dev_a629f2364e2ab427cbdc0c7f1cb8e8a66}{iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  275. 

  276. .end implementation 

  277. 

  278. Definition at line 159 of file in\+\_\+dev.\+h.

  279. 

  280. \mbox{\Hypertarget{classutl_1_1in__dev_aecb438cbb0e2a6c3a926aad81e8c29c7}\label{classutl_1_1in__dev_aecb438cbb0e2a6c3a926aad81e8c29c7}} 

  281. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!end@{end}}

  282. \index{end@{end}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  283. \subsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}

  284. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  285. \mbox{\hyperlink{classutl_1_1in__dev_a686e6cda465a7e08b29465a75740e043}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}

  286. 

  287. 

  288. 

  289. Definition at line 160 of file in\+\_\+dev.\+h.

  290. 

  291. \mbox{\Hypertarget{classutl_1_1in__dev_aa13a075d41f3e020f4f67c2a59d580a5}\label{classutl_1_1in__dev_aa13a075d41f3e020f4f67c2a59d580a5}} 

  292. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!get@{get}}

  293. \index{get@{get}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  294. \subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}

  295. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  296. \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::get (\begin{DoxyParamCaption}\item[{data\+\_\+t \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

  297. 

  298. 

  299. 

  300. Get interface. This function should read a single data\+\_\+t object from device in blocking mode. 

  301. 

  302. 

  303. \begin{DoxyParams}{Parameters}

  304. {\em data} & Reference to data output from device. \\

  305. \hline

  306. \end{DoxyParams}

  307. \begin{DoxyReturn}{Returns}

  308. Number of data read from device 

  309. \end{DoxyReturn}

  310. \begin{DoxyNote}{Note}

  311. A successful call should return 1 

  312. \end{DoxyNote}

  313. 

  314. 

  315. Definition at line 97 of file in\+\_\+dev.\+h.

  316. 

  317. \mbox{\Hypertarget{classutl_1_1in__dev_a5536fdd877bc9f078a9ede43ccc283e7}\label{classutl_1_1in__dev_a5536fdd877bc9f078a9ede43ccc283e7}} 

  318. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!get@{get}}

  319. \index{get@{get}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  320. \subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}

  321. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  322. \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::get (\begin{DoxyParamCaption}\item[{data\+\_\+t $\ast$}]{data,  }\item[{\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}}}]{n }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

  323. 

  324. 

  325. 

  326. Old stile get functionality using free standing data\+\_\+t$\ast$. This function should return a stream of data from device. 

  327. 

  328. 

  329. \begin{DoxyParams}{Parameters}

  330. {\em data} & Pointer to buffer to write the data from device. \\

  331. \hline

  332. {\em n} & The number of data of type data\+\_\+t to read \\

  333. \hline

  334. \end{DoxyParams}

  335. \begin{DoxyReturn}{Returns}

  336. The read data items. 

  337. \end{DoxyReturn}

  338. 

  339. 

  340. Definition at line 109 of file in\+\_\+dev.\+h.

  341. 

  342. \mbox{\Hypertarget{classutl_1_1in__dev_a55dc56f1277b2bd04b154fbf19d8853f}\label{classutl_1_1in__dev_a55dc56f1277b2bd04b154fbf19d8853f}} 

  343. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!operator=@{operator=}}

  344. \index{operator=@{operator=}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  345. \subsubsection{\texorpdfstring{operator=()}{operator=()}}

  346. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  347. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator= (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}

  348. 

  349. No copy assignments \mbox{\Hypertarget{classutl_1_1in__dev_abe8aa85c0dbe0ddb3745ded02b4e68fe}\label{classutl_1_1in__dev_abe8aa85c0dbe0ddb3745ded02b4e68fe}} 

  350. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}

  351. \index{operator$>$$>$@{operator$>$$>$}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  352. \subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}

  353. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  354. template$<$typename \+\_\+\+Dst\+\_\+t $>$ \\

  355. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{\+\_\+\+Dst\+\_\+t \&}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

  356. 

  357. 

  358. 

  359. Template operator $>$$>$ implementation for for all by value/ref parameters. 

  360. 

  361. \begin{DoxyNote}{Note}

  362. In the case \+\_\+\+Dst\+\_\+t size is not a integer multiple of device\textquotesingle{}s data size this will fail by static assertion 

  363. \end{DoxyNote}

  364. 

  365. \begin{DoxyParams}{Parameters}

  366. {\em dst} & Reference to destination \\

  367. \hline

  368. \end{DoxyParams}

  369. \begin{DoxyReturn}{Returns}

  370. Reference to this device for chaining 

  371. \end{DoxyReturn}

  372. 

  373. 

  374. Definition at line 129 of file in\+\_\+dev.\+h.

  375. 

  376. \mbox{\Hypertarget{classutl_1_1in__dev_a60b3bba96e6bfd2091e594fdbc93fd6f}\label{classutl_1_1in__dev_a60b3bba96e6bfd2091e594fdbc93fd6f}} 

  377. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}

  378. \index{operator$>$$>$@{operator$>$$>$}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  379. \subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}

  380. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  381. template$<$typename \+\_\+\+Dst\+\_\+t $>$ \\

  382. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{\+\_\+\+Dst\+\_\+t $\ast$}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}}

  383. 

  384. 

  385. 

  386. Specialization to disallow pointer types as destination. 

  387. 

  388. \mbox{\Hypertarget{classutl_1_1in__dev_a98774619e8575162a8be271833282690}\label{classutl_1_1in__dev_a98774619e8575162a8be271833282690}} 

  389. \index{utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}

  390. \index{operator$>$$>$@{operator$>$$>$}!utl\+::in\+\_\+dev@{utl\+::in\+\_\+dev}}

  391. \subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}

  392. {\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\

  393. \mbox{\hyperlink{classutl_1_1in__dev}{in\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1in__dev}{utl\+::in\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{data\+\_\+t \&}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

  394. 

  395. 

  396. 

  397. Overload for single data\+\_\+t object. 

  398. 

  399. 

  400. 

  401. Definition at line 140 of file in\+\_\+dev.\+h.

  402. 

  403. 

  404. 

  405. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}

  406. \item 

  407. include/utl/dev/\mbox{\hyperlink{in__dev_8h}{in\+\_\+dev.\+h}}\end{DoxyCompactItemize}