424 lines
27 KiB
TeX
424 lines
27 KiB
TeX
\hypertarget{classutl_1_1inbuf__dev}{}\section{utl\+:\+:inbuf\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$ Class Template Reference}
|
|
\label{classutl_1_1inbuf__dev}\index{utl\+::inbuf\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$@{utl\+::inbuf\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$}}
|
|
|
|
|
|
Abstract base class for input buffered devices.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$inbuf\+\_\+dev.\+h$>$}
|
|
|
|
\subsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev_ae429fbf167bbd96b2cc46094f3540b10}{type}} = \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}
|
|
\begin{DoxyCompactList}\small\item\em Export type as identity meta-\/function. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\textbf{ }\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev_ae660dce5b5111b0ea4743e32b3d2c3aa}{data\+\_\+type}} = data\+\_\+t
|
|
\item
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev_a345d3b465e9cf57ebe3a8df31b67fec7}{pointer\+\_\+type}} = data\+\_\+t $\ast$
|
|
\end{DoxyCompactItemize}
|
|
|
|
\subsection*{Public Member Functions}
|
|
\begin{Indent}\textbf{ Public Get interface}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev_aa5b71a9b0c989c4686a053e9d5df9251}{in\+\_\+avail}} ()
|
|
\item
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev_a7856963b0bb0bf294be53ea20f3564d0}{get}} (data\+\_\+t \&data)
|
|
\begin{DoxyCompactList}\small\item\em The base get interface. This function should read a single data\+\_\+t object from device usually in non-\/blocking mode. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev_a9290fbfeebac0d161f800bc1522ea5a6}{get}} (data\+\_\+t $\ast$data, \mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} n)
|
|
\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}
|
|
\end{Indent}
|
|
\begin{Indent}\textbf{ Stream operator $>$$>$ interface}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename \+\_\+\+Dst\+\_\+t $>$ }\\\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1inbuf__dev_aca17fb240dfe221effa5a2092563d185}{operator$>$$>$}} (\+\_\+\+Dst\+\_\+t \&dst)
|
|
\begin{DoxyCompactList}\small\item\em Template operator $>$$>$ implementation for for all by value/ref parameters. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename \+\_\+\+Dst\+\_\+t $>$ }\\\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1inbuf__dev_a48a8160d1dce4542b0b09cff3f6a488b}{operator$>$$>$}} (\+\_\+\+Dst\+\_\+t $\ast$dst)=delete
|
|
\begin{DoxyCompactList}\small\item\em Specialization to disallow pointer types as destination. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1inbuf__dev_a6b11ed7628520b4dfe0bd438ccc58197}{operator$>$$>$}} (data\+\_\+t \&dst)
|
|
\begin{DoxyCompactList}\small\item\em Overload for single data\+\_\+t object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\end{Indent}
|
|
\textbf{ }\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_aea05a40b3c8966d1dd3978b40e0c6ac8}{end}} () noexcept
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_aa862f748551da0bd92341f8f125b8aa3}{end}} () const noexcept
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_a4b51121e0ecc1d43fd3fe7d05bb6fa56}{cend}} () const noexcept
|
|
\end{DoxyCompactItemize}
|
|
|
|
\subsection*{Protected Member Functions}
|
|
\begin{Indent}\textbf{ Constructor / Destructor}\par
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a55763f1c3ba5610404df70bda1abe75b}{$\sim$inbuf\+\_\+dev}} ()=default
|
|
\begin{DoxyCompactList}\small\item\em Allow destructor from derived only. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a9bc1f15ed57132539749d390d5bb03b9}{inbuf\+\_\+dev}} ()=default
|
|
\begin{DoxyCompactList}\small\item\em A default constructor from derived only. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a0fe7d9f726d8a0f2b23df6d9520b58ed}{inbuf\+\_\+dev}} (const \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \&)=delete
|
|
\begin{DoxyCompactList}\small\item\em No copies. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \& \mbox{\hyperlink{classutl_1_1inbuf__dev_a7aaf5bc892d6247cb6bb547cf331704c}{operator=}} (const \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \&)=delete
|
|
\end{DoxyCompactItemize}
|
|
\end{Indent}
|
|
\subsection*{S\+T\+L-\/like Input iterator interface}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}}$<$ \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}, data\+\_\+t $\ast$, streamsize $>$
|
|
\begin{DoxyCompactList}\small\item\em Iterator. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}}$<$ \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}, const data\+\_\+t $\ast$, streamsize $>$
|
|
\begin{DoxyCompactList}\small\item\em Const iterator. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_a0b7b02345e2306dc9f62a75029de71fb}{begin}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em .begin implementation \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_acf6f21857302843661cdbbbeea61f05b}{begin}} () const noexcept
|
|
\item
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev_a3c24ad3be57e15019e3fbd579e5fccb3}{cbegin}} () const noexcept
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$typename impl\+\_\+t, typename data\+\_\+t, size\+\_\+t streamsize = 0$>$\newline
|
|
class utl\+::inbuf\+\_\+dev$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$}
|
|
|
|
Abstract base class for input buffered devices.
|
|
|
|
Template base class for buffered input buffered devices. using C\+R\+TP
|
|
|
|
This class force a common interface for input, buffered devices. By using this common interface the class implements
|
|
\begin{DoxyItemize}
|
|
\item Stream-\/like extracting operator
|
|
\item Input iterator
|
|
\item Const input iterator to inherit to implementation.
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em impl\+\_\+t} & The C\+R\+TP type (the derived/implementation class typename). \\
|
|
\hline
|
|
{\em data\+\_\+t} & The devices base type of data \\
|
|
\hline
|
|
{\em streamsize} & The number of elements to indicate eos. \begin{DoxyItemize}
|
|
\item None or 0 Stream only. No iterator as \mbox{\hyperlink{classutl_1_1inbuf__dev_a0b7b02345e2306dc9f62a75029de71fb}{begin()}} now equals \mbox{\hyperlink{classutl_1_1inbuf__dev_aea05a40b3c8966d1dd3978b40e0c6ac8}{end()}}. \end{DoxyItemize}
|
|
\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line 55 of file inbuf\+\_\+dev.\+h.
|
|
|
|
|
|
|
|
\subsection{Member Typedef Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}\label{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!const\+\_\+iterator@{const\+\_\+iterator}}
|
|
\index{const\+\_\+iterator@{const\+\_\+iterator}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{const\+\_\+iterator}{const\_iterator}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}} $<$\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}, const data\+\_\+t$\ast$, streamsize$>$}
|
|
|
|
|
|
|
|
Const iterator.
|
|
|
|
|
|
|
|
Definition at line 162 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_ae660dce5b5111b0ea4743e32b3d2c3aa}\label{classutl_1_1inbuf__dev_ae660dce5b5111b0ea4743e32b3d2c3aa}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!data\+\_\+type@{data\+\_\+type}}
|
|
\index{data\+\_\+type@{data\+\_\+type}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{data\+\_\+type}{data\_type}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev_ae660dce5b5111b0ea4743e32b3d2c3aa}{data\+\_\+type}} = data\+\_\+t}
|
|
|
|
Export types as input device concept demands
|
|
|
|
Definition at line 62 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}\label{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!iterator@{iterator}}
|
|
\index{iterator@{iterator}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{iterator}{iterator}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} = \mbox{\hyperlink{classutl_1_1indev__it}{indev\+\_\+it}} $<$\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}, data\+\_\+t$\ast$, streamsize$>$}
|
|
|
|
|
|
|
|
Iterator.
|
|
|
|
|
|
|
|
Definition at line 161 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a345d3b465e9cf57ebe3a8df31b67fec7}\label{classutl_1_1inbuf__dev_a345d3b465e9cf57ebe3a8df31b67fec7}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!pointer\+\_\+type@{pointer\+\_\+type}}
|
|
\index{pointer\+\_\+type@{pointer\+\_\+type}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{pointer\+\_\+type}{pointer\_type}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev_a345d3b465e9cf57ebe3a8df31b67fec7}{pointer\+\_\+type}} = data\+\_\+t$\ast$}
|
|
|
|
|
|
|
|
Definition at line 63 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_ae429fbf167bbd96b2cc46094f3540b10}\label{classutl_1_1inbuf__dev_ae429fbf167bbd96b2cc46094f3540b10}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!type@{type}}
|
|
\index{type@{type}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{type}{type}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
using \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev_ae429fbf167bbd96b2cc46094f3540b10}{type}} = \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}}
|
|
|
|
|
|
|
|
Export type as identity meta-\/function.
|
|
|
|
|
|
|
|
Definition at line 65 of file inbuf\+\_\+dev.\+h.
|
|
|
|
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a55763f1c3ba5610404df70bda1abe75b}\label{classutl_1_1inbuf__dev_a55763f1c3ba5610404df70bda1abe75b}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!````~inbuf\+\_\+dev@{$\sim$inbuf\+\_\+dev}}
|
|
\index{````~inbuf\+\_\+dev@{$\sim$inbuf\+\_\+dev}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{$\sim$inbuf\+\_\+dev()}{~inbuf\_dev()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::$\sim$\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
|
|
|
|
|
|
|
|
Allow destructor from derived only.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a9bc1f15ed57132539749d390d5bb03b9}\label{classutl_1_1inbuf__dev_a9bc1f15ed57132539749d390d5bb03b9}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!inbuf\+\_\+dev@{inbuf\+\_\+dev}}
|
|
\index{inbuf\+\_\+dev@{inbuf\+\_\+dev}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{inbuf\+\_\+dev()}{inbuf\_dev()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
|
|
|
|
|
|
|
|
A default constructor from derived only.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a0fe7d9f726d8a0f2b23df6d9520b58ed}\label{classutl_1_1inbuf__dev_a0fe7d9f726d8a0f2b23df6d9520b58ed}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!inbuf\+\_\+dev@{inbuf\+\_\+dev}}
|
|
\index{inbuf\+\_\+dev@{inbuf\+\_\+dev}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{inbuf\+\_\+dev()}{inbuf\_dev()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev}} (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}
|
|
|
|
|
|
|
|
No copies.
|
|
|
|
|
|
|
|
\subsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a0b7b02345e2306dc9f62a75029de71fb}\label{classutl_1_1inbuf__dev_a0b7b02345e2306dc9f62a75029de71fb}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!begin@{begin}}
|
|
\index{begin@{begin}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::begin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
.begin implementation
|
|
|
|
|
|
|
|
Definition at line 165 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_acf6f21857302843661cdbbbeea61f05b}\label{classutl_1_1inbuf__dev_acf6f21857302843661cdbbbeea61f05b}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!begin@{begin}}
|
|
\index{begin@{begin}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::begin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 166 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a3c24ad3be57e15019e3fbd579e5fccb3}\label{classutl_1_1inbuf__dev_a3c24ad3be57e15019e3fbd579e5fccb3}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!cbegin@{cbegin}}
|
|
\index{cbegin@{cbegin}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{cbegin()}{cbegin()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::cbegin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 167 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a4b51121e0ecc1d43fd3fe7d05bb6fa56}\label{classutl_1_1inbuf__dev_a4b51121e0ecc1d43fd3fe7d05bb6fa56}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!cend@{cend}}
|
|
\index{cend@{cend}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{cend()}{cend()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::cend (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 172 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_aea05a40b3c8966d1dd3978b40e0c6ac8}\label{classutl_1_1inbuf__dev_aea05a40b3c8966d1dd3978b40e0c6ac8}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!end@{end}}
|
|
\index{end@{end}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a0c0827ae69fac778cec3abb179bfc0f3}{iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
.end implementation
|
|
|
|
Definition at line 170 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_aa862f748551da0bd92341f8f125b8aa3}\label{classutl_1_1inbuf__dev_aa862f748551da0bd92341f8f125b8aa3}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!end@{end}}
|
|
\index{end@{end}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev_a173c37503cdd40e7ac1be25759553c24}{const\+\_\+iterator}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Definition at line 171 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a7856963b0bb0bf294be53ea20f3564d0}\label{classutl_1_1inbuf__dev_a7856963b0bb0bf294be53ea20f3564d0}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!get@{get}}
|
|
\index{get@{get}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::get (\begin{DoxyParamCaption}\item[{data\+\_\+t \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
The base get interface. This function should read a single data\+\_\+t object from device usually in non-\/blocking mode.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em data} & Reference to data output from device. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Number of data read from device
|
|
\end{DoxyReturn}
|
|
\begin{DoxyNote}{Note}
|
|
A successful call should return 1
|
|
\end{DoxyNote}
|
|
|
|
|
|
Definition at line 108 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a9290fbfeebac0d161f800bc1522ea5a6}\label{classutl_1_1inbuf__dev_a9290fbfeebac0d161f800bc1522ea5a6}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!get@{get}}
|
|
\index{get@{get}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+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]}}
|
|
|
|
|
|
|
|
Old stile get functionality using free standing data\+\_\+t$\ast$. This function should return a stream of data from device.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em data} & Pointer to buffer to write the data from device. \\
|
|
\hline
|
|
{\em n} & The number of data of type data\+\_\+t to read \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The read data items.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 120 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_aa5b71a9b0c989c4686a053e9d5df9251}\label{classutl_1_1inbuf__dev_aa5b71a9b0c989c4686a053e9d5df9251}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!in\+\_\+avail@{in\+\_\+avail}}
|
|
\index{in\+\_\+avail@{in\+\_\+avail}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{in\+\_\+avail()}{in\_avail()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{namespaceutl_a22cbecb50ee5c1032de66133e96cbac6}{size\+\_\+t}} \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::in\+\_\+avail (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
The available {\itshape data\+\_\+t} typed items in input buffer.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 95 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a7aaf5bc892d6247cb6bb547cf331704c}\label{classutl_1_1inbuf__dev_a7aaf5bc892d6247cb6bb547cf331704c}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!operator=@{operator=}}
|
|
\index{operator=@{operator=}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{operator=()}{operator=()}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator= (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [delete]}}
|
|
|
|
No copy assignments \mbox{\Hypertarget{classutl_1_1inbuf__dev_aca17fb240dfe221effa5a2092563d185}\label{classutl_1_1inbuf__dev_aca17fb240dfe221effa5a2092563d185}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}
|
|
\index{operator$>$$>$@{operator$>$$>$}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
template$<$typename \+\_\+\+Dst\+\_\+t $>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{\+\_\+\+Dst\+\_\+t \&}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Template operator $>$$>$ implementation for for all by value/ref parameters.
|
|
|
|
\begin{DoxyNote}{Note}
|
|
In the case \+\_\+\+Dst\+\_\+t size is not a integer multiple of device\textquotesingle{}s data size this will fail by static assertion
|
|
\end{DoxyNote}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em dst} & Reference to destination \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Reference to this device for chaining
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line 140 of file inbuf\+\_\+dev.\+h.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a48a8160d1dce4542b0b09cff3f6a488b}\label{classutl_1_1inbuf__dev_a48a8160d1dce4542b0b09cff3f6a488b}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}
|
|
\index{operator$>$$>$@{operator$>$$>$}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
template$<$typename \+\_\+\+Dst\+\_\+t $>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{\+\_\+\+Dst\+\_\+t $\ast$}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}}
|
|
|
|
|
|
|
|
Specialization to disallow pointer types as destination.
|
|
|
|
\mbox{\Hypertarget{classutl_1_1inbuf__dev_a6b11ed7628520b4dfe0bd438ccc58197}\label{classutl_1_1inbuf__dev_a6b11ed7628520b4dfe0bd438ccc58197}}
|
|
\index{utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}!operator$>$$>$@{operator$>$$>$}}
|
|
\index{operator$>$$>$@{operator$>$$>$}!utl\+::inbuf\+\_\+dev@{utl\+::inbuf\+\_\+dev}}
|
|
\subsubsection{\texorpdfstring{operator$>$$>$()}{operator>>()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
|
|
{\footnotesize\ttfamily template$<$typename impl\+\_\+t , typename data\+\_\+t , size\+\_\+t streamsize = 0$>$ \\
|
|
\mbox{\hyperlink{classutl_1_1inbuf__dev}{inbuf\+\_\+dev\+\_\+t}}\& \mbox{\hyperlink{classutl_1_1inbuf__dev}{utl\+::inbuf\+\_\+dev}}$<$ impl\+\_\+t, data\+\_\+t, streamsize $>$\+::operator$>$$>$ (\begin{DoxyParamCaption}\item[{data\+\_\+t \&}]{dst }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Overload for single data\+\_\+t object.
|
|
|
|
|
|
|
|
Definition at line 151 of file inbuf\+\_\+dev.\+h.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
include/utl/dev/\mbox{\hyperlink{inbuf__dev_8h}{inbuf\+\_\+dev.\+h}}\end{DoxyCompactItemize}
|