library/Doku/Doxygen/latex/db/ddd/group__lowerlevelusgetters.tex
2018-11-13 11:15:10 +01:00

121 lines
6.2 KiB
TeX

\hypertarget{group__lowerlevelusgetters}{}\section{Setters and getters}
\label{group__lowerlevelusgetters}\index{Setters and getters@{Setters and getters}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
void \hyperlink{group__lowerlevelusgetters_gaa7c5a6563a5736ed38d12f616de480df}{Code\+Racer\+::usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm} (unsigned long stop\+\_\+distance\+\_\+cm)
\begin{DoxyCompactList}\small\item\em Sets the stop distance in cm. \end{DoxyCompactList}\item
void \hyperlink{group__lowerlevelusgetters_ga2f06c193ae86c5b1cba450caf5adf146}{Code\+Racer\+::usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us} (unsigned long stop\+\_\+distance\+\_\+us)
\begin{DoxyCompactList}\small\item\em Sets the stop distance in cm. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__lowerlevelusgetters_ga917b90f21e731ef5f690d5198e7f4d3e}{Code\+Racer\+::usonic\+\_\+distance\+\_\+us} ()
\begin{DoxyCompactList}\small\item\em Returns the last measured distance in microseconds. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__lowerlevelusgetters_gad59842c14196598e55644b2a22621454}{Code\+Racer\+::usonic\+\_\+distance\+\_\+cm} ()
\begin{DoxyCompactList}\small\item\em Returns the last measured distance in cm. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Detailed Description}
\subsection{Function Documentation}
\mbox{\Hypertarget{group__lowerlevelusgetters_gaa7c5a6563a5736ed38d12f616de480df}\label{group__lowerlevelusgetters_gaa7c5a6563a5736ed38d12f616de480df}}
\index{Setters and getters@{Setters and getters}!usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm@{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm}}
\index{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm@{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm}!Setters and getters@{Setters and getters}}
\subsubsection{\texorpdfstring{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm()}{usonic\_set\_stop\_distance\_cm()}}
{\footnotesize\ttfamily void Code\+Racer\+::usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+cm (\begin{DoxyParamCaption}\item[{unsigned long}]{stop\+\_\+distance\+\_\+cm }\end{DoxyParamCaption})}
Sets the stop distance in cm.
If start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is used and distance measured with one of the measurement methods -\/ the racer will be stopped immediately. All except the singe shot methods of the ultra sonic measurements methods supports that. Internally the stop distance will be set as both -\/ in cm and in microseconds.
\begin{DoxyParams}{Parameters}
{\em stop\+\_\+distance\+\_\+cm} & Distance in cm the racer will be stopped if that features was enabled by start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() before. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
nothing
\end{DoxyReturn}
Definition at line 825 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
826 \{
827 \_usonic\_stop\_distance\_us = stop\_distance\_cm * 58.14;
828 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerlevelusgetters_ga2f06c193ae86c5b1cba450caf5adf146}\label{group__lowerlevelusgetters_ga2f06c193ae86c5b1cba450caf5adf146}}
\index{Setters and getters@{Setters and getters}!usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us@{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us}}
\index{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us@{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us}!Setters and getters@{Setters and getters}}
\subsubsection{\texorpdfstring{usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us()}{usonic\_set\_stop\_distance\_us()}}
{\footnotesize\ttfamily void Code\+Racer\+::usonic\+\_\+set\+\_\+stop\+\_\+distance\+\_\+us (\begin{DoxyParamCaption}\item[{unsigned long}]{stop\+\_\+distance\+\_\+us }\end{DoxyParamCaption})}
Sets the stop distance in cm.
If start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is used and distance measured with one of the measurement methods -\/ the racer will be stopped immediately. All except the singe shot methods of the ultra sonic measurements methods supports that. Internally the stop distance will be set as both -\/ in cm and in microseconds.
\begin{DoxyParams}{Parameters}
{\em stop\+\_\+distance\+\_\+us} & Distance in cm the racer will be stopped if that features was enabled by start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() before. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
nothing
\end{DoxyReturn}
Definition at line 837 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
838 \{
839 \_usonic\_stop\_distance\_us = stop\_distance\_us;
840 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerlevelusgetters_ga917b90f21e731ef5f690d5198e7f4d3e}\label{group__lowerlevelusgetters_ga917b90f21e731ef5f690d5198e7f4d3e}}
\index{Setters and getters@{Setters and getters}!usonic\+\_\+distance\+\_\+us@{usonic\+\_\+distance\+\_\+us}}
\index{usonic\+\_\+distance\+\_\+us@{usonic\+\_\+distance\+\_\+us}!Setters and getters@{Setters and getters}}
\subsubsection{\texorpdfstring{usonic\+\_\+distance\+\_\+us()}{usonic\_distance\_us()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::usonic\+\_\+distance\+\_\+us (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Returns the last measured distance in microseconds.
\begin{DoxyReturn}{Returns}
Distance in microseconds
\end{DoxyReturn}
Definition at line 845 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
845 \{
846 \textcolor{keywordflow}{return}(\_usonic\_distance\_us);
847 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerlevelusgetters_gad59842c14196598e55644b2a22621454}\label{group__lowerlevelusgetters_gad59842c14196598e55644b2a22621454}}
\index{Setters and getters@{Setters and getters}!usonic\+\_\+distance\+\_\+cm@{usonic\+\_\+distance\+\_\+cm}}
\index{usonic\+\_\+distance\+\_\+cm@{usonic\+\_\+distance\+\_\+cm}!Setters and getters@{Setters and getters}}
\subsubsection{\texorpdfstring{usonic\+\_\+distance\+\_\+cm()}{usonic\_distance\_cm()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::usonic\+\_\+distance\+\_\+cm (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Returns the last measured distance in cm.
\begin{DoxyReturn}{Returns}
Distance in cm
\end{DoxyReturn}
Definition at line 852 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
852 \{
853 \textcolor{keywordflow}{return}(\_usonic\_distance\_cm);
854 \}
\end{DoxyCode}