\doxysection{Usb\+Settings Class Reference}
\hypertarget{a00956}{}\label{a00956}\index{UsbSettings@{UsbSettings}}


The USB settings encapsulation for USB communication.  




{\ttfamily \#include $<$Usb\+Settings.\+h$>$}

Inheritance diagram for Usb\+Settings\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{a00956}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{a00956_a273bbdb90536a30fe82b57a583c7248f}{Usb\+Settings}} ()
\begin{DoxyCompactList}\small\item\em Base constructor. \end{DoxyCompactList}\item 
\mbox{\hyperlink{a00956_a7ce454d96bcde47c819af6e65a5d304d}{Usb\+Settings}} (unsigned int vendor\+Id, unsigned int product\+Id, unsigned int read\+Channel, unsigned int write\+Channel)
\begin{DoxyCompactList}\small\item\em Copy constructor. \end{DoxyCompactList}\item 
\mbox{\hyperlink{a00956_a41b23a36efa1a50b6cc47bf428a905a3}{Usb\+Settings}} (unsigned int vendor\+Id, unsigned int product\+Id, unsigned int read\+Channel, unsigned int write\+Channel, int p\+Data\+Timeout)
\begin{DoxyCompactList}\small\item\em Copy constructor. \end{DoxyCompactList}\item 
\mbox{\hyperlink{a00956_a5050e6adeb0cb44ad86c6ac30ef75768}{\texorpdfstring{$\sim$}{\string~}\+Usb\+Settings}} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
unsigned int \mbox{\hyperlink{a00956_ae516e807b3a79e5b7c619a04b3bd3a7c}{Get\+Vendor\+Id}} ()
\begin{DoxyCompactList}\small\item\em Gets the device\textquotesingle{}s vendor identifier. \end{DoxyCompactList}\item 
unsigned int \mbox{\hyperlink{a00956_a46a14981717cb8a3f3286c732b287956}{Get\+Product\+Id}} ()
\begin{DoxyCompactList}\small\item\em Gets the device\textquotesingle{}s product identifier. \end{DoxyCompactList}\item 
unsigned int \mbox{\hyperlink{a00956_ab96d378bc141c629a192e3368cdd341e}{Get\+Read\+Channel}} ()
\begin{DoxyCompactList}\small\item\em Get the device\textquotesingle{}s input channel. \end{DoxyCompactList}\item 
unsigned int \mbox{\hyperlink{a00956_a3028a48a060139fbcd5cdf8dff9a3b4a}{Get\+Write\+Channel}} ()
\begin{DoxyCompactList}\small\item\em Gets the device output channel. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{a00956_a06a8ab6935f1a25c3b025c561b373e0b}{Set\+Vendor\+Id}} (unsigned int vendor\+Id)
\begin{DoxyCompactList}\small\item\em Sets the device\textquotesingle{}s vendor identifier. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{a00956_af8e8c78dca26ab3ea191afb989642d35}{Set\+Product\+Id}} (unsigned int product\+Id)
\begin{DoxyCompactList}\small\item\em Sets the device\textquotesingle{}s product identifier. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{a00956_ac08fce0777b77a21ad8f9dd6bebf14c3}{Set\+Read\+Channel}} (unsigned int input\+Channel)
\begin{DoxyCompactList}\small\item\em Sets the device\textquotesingle{}s input channel. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{a00956_ae00bd2a2b9e5cddf93b5a0d4175f1940}{Set\+Write\+Channel}} (unsigned int output\+Channel)
\begin{DoxyCompactList}\small\item\em Sets the device\textquotesingle{}s output channel. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The USB settings encapsulation for USB communication. 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{a00956_a273bbdb90536a30fe82b57a583c7248f}\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{UsbSettings()}{UsbSettings()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily \label{a00956_a273bbdb90536a30fe82b57a583c7248f} 
Usb\+Settings\+::\+Usb\+Settings (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Base constructor. 

\Hypertarget{a00956_a7ce454d96bcde47c819af6e65a5d304d}\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{UsbSettings()}{UsbSettings()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily \label{a00956_a7ce454d96bcde47c819af6e65a5d304d} 
Usb\+Settings\+::\+Usb\+Settings (\begin{DoxyParamCaption}\item[{unsigned int}]{vendor\+Id}{, }\item[{unsigned int}]{product\+Id}{, }\item[{unsigned int}]{read\+Channel}{, }\item[{unsigned int}]{write\+Channel}{}\end{DoxyParamCaption})}



Copy constructor. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The hardware vendor identifier\\
\hline
{\em product\+Id} & The hardware product identifier\\
\hline
{\em write\+Channel} & The device\textquotesingle{}s channel identifier on which command must be sent\\
\hline
{\em read\+Channel} & The device\textquotesingle{}s channel identifier on which ackowledgments and raw data will be sent\\
\hline
\end{DoxyParams}
\Hypertarget{a00956_a41b23a36efa1a50b6cc47bf428a905a3}\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\index{UsbSettings@{UsbSettings}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{UsbSettings()}{UsbSettings()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily \label{a00956_a41b23a36efa1a50b6cc47bf428a905a3} 
Usb\+Settings\+::\+Usb\+Settings (\begin{DoxyParamCaption}\item[{unsigned int}]{vendor\+Id}{, }\item[{unsigned int}]{product\+Id}{, }\item[{unsigned int}]{read\+Channel}{, }\item[{unsigned int}]{write\+Channel}{, }\item[{int}]{p\+Data\+Timeout}{}\end{DoxyParamCaption})}



Copy constructor. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The hardware vendor identifier\\
\hline
{\em product\+Id} & The hardware product identifier\\
\hline
{\em write\+Channel} & The device\textquotesingle{}s channel identifier on which command must be sent\\
\hline
{\em read\+Channel} & The device\textquotesingle{}s channel identifier on which ackowledgments and raw data will be sent\\
\hline
\end{DoxyParams}
\texorpdfstring{$<$}{<}param name="{}p\+Data\+Timeout"{}\texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>}UDP Port number\texorpdfstring{$>$}{>}The max time elapsed between two data sent\Hypertarget{a00956_a5050e6adeb0cb44ad86c6ac30ef75768}\index{UsbSettings@{UsbSettings}!````~UsbSettings@{\texorpdfstring{$\sim$}{\string~}UsbSettings}}
\index{````~UsbSettings@{\texorpdfstring{$\sim$}{\string~}UsbSettings}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}UsbSettings()}{\string~UsbSettings()}}
{\footnotesize\ttfamily \label{a00956_a5050e6adeb0cb44ad86c6ac30ef75768} 
Usb\+Settings\+::\texorpdfstring{$\sim$}{\string~}\+Usb\+Settings (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Destructor. 



\doxysubsection{Member Function Documentation}
\Hypertarget{a00956_a46a14981717cb8a3f3286c732b287956}\index{UsbSettings@{UsbSettings}!GetProductId@{GetProductId}}
\index{GetProductId@{GetProductId}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{GetProductId()}{GetProductId()}}
{\footnotesize\ttfamily \label{a00956_a46a14981717cb8a3f3286c732b287956} 
unsigned int Usb\+Settings\+::\+Get\+Product\+Id (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Gets the device\textquotesingle{}s product identifier. 

\begin{DoxyReturn}{Returns}
The device\textquotesingle{}s product identifier
\end{DoxyReturn}
\Hypertarget{a00956_ab96d378bc141c629a192e3368cdd341e}\index{UsbSettings@{UsbSettings}!GetReadChannel@{GetReadChannel}}
\index{GetReadChannel@{GetReadChannel}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{GetReadChannel()}{GetReadChannel()}}
{\footnotesize\ttfamily \label{a00956_ab96d378bc141c629a192e3368cdd341e} 
unsigned int Usb\+Settings\+::\+Get\+Read\+Channel (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Get the device\textquotesingle{}s input channel. 

\begin{DoxyReturn}{Returns}
The device\textquotesingle{}s input channel
\end{DoxyReturn}
\Hypertarget{a00956_ae516e807b3a79e5b7c619a04b3bd3a7c}\index{UsbSettings@{UsbSettings}!GetVendorId@{GetVendorId}}
\index{GetVendorId@{GetVendorId}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{GetVendorId()}{GetVendorId()}}
{\footnotesize\ttfamily \label{a00956_ae516e807b3a79e5b7c619a04b3bd3a7c} 
unsigned int Usb\+Settings\+::\+Get\+Vendor\+Id (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Gets the device\textquotesingle{}s vendor identifier. 

\begin{DoxyReturn}{Returns}
The device\textquotesingle{}s vendor identifier
\end{DoxyReturn}
\Hypertarget{a00956_a3028a48a060139fbcd5cdf8dff9a3b4a}\index{UsbSettings@{UsbSettings}!GetWriteChannel@{GetWriteChannel}}
\index{GetWriteChannel@{GetWriteChannel}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{GetWriteChannel()}{GetWriteChannel()}}
{\footnotesize\ttfamily \label{a00956_a3028a48a060139fbcd5cdf8dff9a3b4a} 
unsigned int Usb\+Settings\+::\+Get\+Write\+Channel (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Gets the device output channel. 

\begin{DoxyReturn}{Returns}
The device\textquotesingle{}s ouput channel
\end{DoxyReturn}
\Hypertarget{a00956_af8e8c78dca26ab3ea191afb989642d35}\index{UsbSettings@{UsbSettings}!SetProductId@{SetProductId}}
\index{SetProductId@{SetProductId}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{SetProductId()}{SetProductId()}}
{\footnotesize\ttfamily \label{a00956_af8e8c78dca26ab3ea191afb989642d35} 
void Usb\+Settings\+::\+Set\+Product\+Id (\begin{DoxyParamCaption}\item[{unsigned int}]{product\+Id}{}\end{DoxyParamCaption})}



Sets the device\textquotesingle{}s product identifier. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The device\textquotesingle{}s prodict identifier\\
\hline
\end{DoxyParams}
\Hypertarget{a00956_ac08fce0777b77a21ad8f9dd6bebf14c3}\index{UsbSettings@{UsbSettings}!SetReadChannel@{SetReadChannel}}
\index{SetReadChannel@{SetReadChannel}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{SetReadChannel()}{SetReadChannel()}}
{\footnotesize\ttfamily \label{a00956_ac08fce0777b77a21ad8f9dd6bebf14c3} 
void Usb\+Settings\+::\+Set\+Read\+Channel (\begin{DoxyParamCaption}\item[{unsigned int}]{input\+Channel}{}\end{DoxyParamCaption})}



Sets the device\textquotesingle{}s input channel. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The device\textquotesingle{}s input channel\\
\hline
\end{DoxyParams}
\Hypertarget{a00956_a06a8ab6935f1a25c3b025c561b373e0b}\index{UsbSettings@{UsbSettings}!SetVendorId@{SetVendorId}}
\index{SetVendorId@{SetVendorId}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{SetVendorId()}{SetVendorId()}}
{\footnotesize\ttfamily \label{a00956_a06a8ab6935f1a25c3b025c561b373e0b} 
void Usb\+Settings\+::\+Set\+Vendor\+Id (\begin{DoxyParamCaption}\item[{unsigned int}]{vendor\+Id}{}\end{DoxyParamCaption})}



Sets the device\textquotesingle{}s vendor identifier. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The device\textquotesingle{}s vendor identifier\\
\hline
\end{DoxyParams}
\Hypertarget{a00956_ae00bd2a2b9e5cddf93b5a0d4175f1940}\index{UsbSettings@{UsbSettings}!SetWriteChannel@{SetWriteChannel}}
\index{SetWriteChannel@{SetWriteChannel}!UsbSettings@{UsbSettings}}
\doxysubsubsection{\texorpdfstring{SetWriteChannel()}{SetWriteChannel()}}
{\footnotesize\ttfamily \label{a00956_ae00bd2a2b9e5cddf93b5a0d4175f1940} 
void Usb\+Settings\+::\+Set\+Write\+Channel (\begin{DoxyParamCaption}\item[{unsigned int}]{output\+Channel}{}\end{DoxyParamCaption})}



Sets the device\textquotesingle{}s output channel. 


\begin{DoxyParams}{Parameters}
{\em vendor\+Id} & The device\textquotesingle{}s output channel\\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Usb\+Settings.\+h\item 
Usb\+Settings.\+cpp\end{DoxyCompactItemize}
