library/Doku/Doxygen/latex/d7/d45/group__higherlevelgetters.tex

\hypertarget{group__higherlevelgetters}{}\section{Getters and setters}
\label{group__higherlevelgetters}\index{Getters and setters@{Getters and setters}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}{Code\+Racer\+::stopped\+\_\+at\+\_\+min\+\_\+distance} ()
\begin{DoxyCompactList}\small\item\em Returns true if the racer was stopped at minimum distance. This set to false each time start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is called. \end{DoxyCompactList}\item 
bool \hyperlink{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}{Code\+Racer\+::is\+\_\+driving} ()
\begin{DoxyCompactList}\small\item\em Return true if the racer is driving -\/ forward or backward. \end{DoxyCompactList}\item 
unsigned long \hyperlink{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}{Code\+Racer\+::turn\+\_\+left\+\_\+for\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Returns the duration of time that is internally stored and used for turning the racer left. \end{DoxyCompactList}\item 
unsigned long \hyperlink{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}{Code\+Racer\+::turn\+\_\+right\+\_\+for\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Returns the duration of time that is internally stored and used for turning the racer left. \end{DoxyCompactList}\item 
void \hyperlink{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}{Code\+Racer\+::set\+\_\+inactive} ()
\begin{DoxyCompactList}\small\item\em Sets the coderracer\+\_\+active state to inactive. If start\+\_\+stop() is used -\/ the inactive mode will be entered. \end{DoxyCompactList}\item 
void \hyperlink{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}{Code\+Racer\+::set\+\_\+active} ()
\begin{DoxyCompactList}\small\item\em Sets the coderracer\+\_\+active state to active. If start\+\_\+stop() is used -\/ the active mode will be entered. \end{DoxyCompactList}\item 
bool \hyperlink{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}{Code\+Racer\+::is\+\_\+active} ()
\begin{DoxyCompactList}\small\item\em Checks if coderracer\+\_\+activ is set. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}


\subsection{Function Documentation}
\mbox{\Hypertarget{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}\label{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}} 
\index{Getters and setters@{Getters and setters}!stopped\+\_\+at\+\_\+min\+\_\+distance@{stopped\+\_\+at\+\_\+min\+\_\+distance}}
\index{stopped\+\_\+at\+\_\+min\+\_\+distance@{stopped\+\_\+at\+\_\+min\+\_\+distance}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{stopped\+\_\+at\+\_\+min\+\_\+distance()}{stopped\_at\_min\_distance()}}
{\footnotesize\ttfamily bool Code\+Racer\+::stopped\+\_\+at\+\_\+min\+\_\+distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns true if the racer was stopped at minimum distance. This set to false each time start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is called. 

\begin{DoxyReturn}{Returns}
True if stopped. 
\end{DoxyReturn}


Definition at line 380 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
380                                         \{
381     \textcolor{keywordflow}{return}(\_coderacer\_stopped\_at\_min\_distance);
382 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}\label{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}} 
\index{Getters and setters@{Getters and setters}!is\+\_\+driving@{is\+\_\+driving}}
\index{is\+\_\+driving@{is\+\_\+driving}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{is\+\_\+driving()}{is\_driving()}}
{\footnotesize\ttfamily bool Code\+Racer\+::is\+\_\+driving (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return true if the racer is driving -\/ forward or backward. 

\begin{DoxyReturn}{Returns}
True if driving forward or backward 
\end{DoxyReturn}


Definition at line 387 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
387                            \{
388     \textcolor{keywordflow}{return}(\_drive);
389 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}\label{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}} 
\index{Getters and setters@{Getters and setters}!turn\+\_\+left\+\_\+for\+\_\+ms@{turn\+\_\+left\+\_\+for\+\_\+ms}}
\index{turn\+\_\+left\+\_\+for\+\_\+ms@{turn\+\_\+left\+\_\+for\+\_\+ms}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{turn\+\_\+left\+\_\+for\+\_\+ms()}{turn\_left\_for\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::turn\+\_\+left\+\_\+for\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the duration of time that is internally stored and used for turning the racer left. 

\begin{DoxyReturn}{Returns}
Time to turn left in ms 
\end{DoxyReturn}


Definition at line 394 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
394                                           \{
395     \textcolor{keywordflow}{return}(\_turn\_left\_for\_ms);
396 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}\label{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}} 
\index{Getters and setters@{Getters and setters}!turn\+\_\+right\+\_\+for\+\_\+ms@{turn\+\_\+right\+\_\+for\+\_\+ms}}
\index{turn\+\_\+right\+\_\+for\+\_\+ms@{turn\+\_\+right\+\_\+for\+\_\+ms}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{turn\+\_\+right\+\_\+for\+\_\+ms()}{turn\_right\_for\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::turn\+\_\+right\+\_\+for\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the duration of time that is internally stored and used for turning the racer left. 

\begin{DoxyReturn}{Returns}
Time to turn left in ms 
\end{DoxyReturn}


Definition at line 401 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
401                                            \{
402     \textcolor{keywordflow}{return}(\_turn\_right\_for\_ms);
403 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}\label{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}} 
\index{Getters and setters@{Getters and setters}!set\+\_\+inactive@{set\+\_\+inactive}}
\index{set\+\_\+inactive@{set\+\_\+inactive}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{set\+\_\+inactive()}{set\_inactive()}}
{\footnotesize\ttfamily void Code\+Racer\+::set\+\_\+inactive (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Sets the coderracer\+\_\+active state to inactive. If start\+\_\+stop() is used -\/ the inactive mode will be entered. 

\begin{DoxyReturn}{Returns}
nothing 
\end{DoxyReturn}


Definition at line 408 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
408                              \{
409     coderracer\_activ = \textcolor{keyword}{false};
410 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}\label{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}} 
\index{Getters and setters@{Getters and setters}!set\+\_\+active@{set\+\_\+active}}
\index{set\+\_\+active@{set\+\_\+active}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{set\+\_\+active()}{set\_active()}}
{\footnotesize\ttfamily void Code\+Racer\+::set\+\_\+active (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Sets the coderracer\+\_\+active state to active. If start\+\_\+stop() is used -\/ the active mode will be entered. 

\begin{DoxyReturn}{Returns}
nothing 
\end{DoxyReturn}


Definition at line 415 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
415                            \{
416     coderracer\_activ = \textcolor{keyword}{true};
417 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}\label{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}} 
\index{Getters and setters@{Getters and setters}!is\+\_\+active@{is\+\_\+active}}
\index{is\+\_\+active@{is\+\_\+active}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{is\+\_\+active()}{is\_active()}}
{\footnotesize\ttfamily bool Code\+Racer\+::is\+\_\+active (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Checks if coderracer\+\_\+activ is set. 

coderracer\+\_\+activ is toggled each time the button is pressed. After power on coderracer\+\_\+activ is set to False. \begin{DoxyReturn}{Returns}
True id coderracer\+\_\+activ is set -\/ False if not. 
\end{DoxyReturn}


Definition at line 424 of file Code\+Racer.\+cpp.


\begin{DoxyCode}
424                           \{
425     \textcolor{keywordflow}{return}(coderracer\_activ);
426 \}
\end{DoxyCode}