doc/doxygen/latex/timers__win32_8cpp.tex
author nico
Thu, 07 Jun 2007 09:03:41 +0200
changeset 213 1df3055de547
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{timers__win32_8cpp}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/win32/timers\_\-win32.cpp File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{timers__win32_8cpp}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/win32/timers_win32.cpp@{/home/epimerde/documents/tc11/CanFestival-3/drivers/win32/timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$windows.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include $<$stdlib.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include \char`\"{}applicfg.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
{\tt \#include \char`\"{}timer.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
{\tt \#include \char`\"{}timers\_\-driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\subsection*{Data Structures}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
class \hyperlink{classccritical__section}{ccritical\_\-section}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
class \hyperlink{classclass__timers}{class\_\-timers}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
void \hyperlink{timers__win32_8cpp_d7fee43b8a44cf8b7036853593044037}{Enter\-Mutex} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
void \hyperlink{timers__win32_8cpp_73d9a4eb941fb20cf6b597840510394b}{Leave\-Mutex} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
void \hyperlink{timers__win32_8cpp_998a8436651e6990d3922ebdc3eebf8b}{Create\-Receive\-Task} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0, TASK\_\-HANDLE $\ast$Thread, void $\ast$Receive\-Loop\-Ptr)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
void \hyperlink{timers__win32_8cpp_4b2486891ee01e06e2deead4cf963727}{Wait\-Receive\-Task\-End} (TASK\_\-HANDLE Thread)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
void \hyperlink{timers__win32_8cpp_c9e1731843825eb55e7a94894e6a8ec5}{Start\-Timer\-Loop} (\hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} init\_\-callback)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
void \hyperlink{timers__win32_8cpp_8758484f3cebb0cd44bb247c3f23d5e3}{Stop\-Timer\-Loop} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
void \hyperlink{timers__win32_8cpp_b8d05dee70f04b5c5190ab00e84da106}{set\-Timer} (TIMEVAL value)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
TIMEVAL \hyperlink{timers__win32_8cpp_4dccc204d52176bd547ab34d6858f5ba}{get\-Elapsed\-Time} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\hypertarget{timers__win32_8cpp_998a8436651e6990d3922ebdc3eebf8b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\index{timers_win32.cpp@{timers\_\-win32.cpp}!CreateReceiveTask@{CreateReceiveTask}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\index{CreateReceiveTask@{CreateReceiveTask}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\subsubsection[CreateReceiveTask]{\setlength{\rightskip}{0pt plus 5cm}void Create\-Receive\-Task (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} {\em fd0}, TASK\_\-HANDLE $\ast$ {\em Thread}, void $\ast$ {\em Receive\-Loop\-Ptr})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\label{timers__win32_8cpp_998a8436651e6990d3922ebdc3eebf8b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
Definition at line 78 of file timers\_\-win32.cpp.\hypertarget{timers__win32_8cpp_d7fee43b8a44cf8b7036853593044037}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\index{timers_win32.cpp@{timers\_\-win32.cpp}!EnterMutex@{EnterMutex}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
\index{EnterMutex@{EnterMutex}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\subsubsection[EnterMutex]{\setlength{\rightskip}{0pt plus 5cm}void Enter\-Mutex (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\label{timers__win32_8cpp_d7fee43b8a44cf8b7036853593044037}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
Definition at line 64 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
References Can\-Festival\_\-mutex, and ccritical\_\-section::enter().\hypertarget{timers__win32_8cpp_4dccc204d52176bd547ab34d6858f5ba}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
\index{timers_win32.cpp@{timers\_\-win32.cpp}!getElapsedTime@{getElapsedTime}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\index{getElapsedTime@{getElapsedTime}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\subsubsection[getElapsedTime]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL get\-Elapsed\-Time (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\label{timers__win32_8cpp_4dccc204d52176bd547ab34d6858f5ba}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
Definition at line 238 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
References class\_\-timers::get\_\-elapsed\_\-time(), IO\_\-PORTS\_\-16, and TC4H.\hypertarget{timers__win32_8cpp_73d9a4eb941fb20cf6b597840510394b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
\index{timers_win32.cpp@{timers\_\-win32.cpp}!LeaveMutex@{LeaveMutex}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\index{LeaveMutex@{LeaveMutex}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\subsubsection[LeaveMutex]{\setlength{\rightskip}{0pt plus 5cm}void Leave\-Mutex (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\label{timers__win32_8cpp_73d9a4eb941fb20cf6b597840510394b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
Definition at line 69 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
References Can\-Festival\_\-mutex, and ccritical\_\-section::leave().\hypertarget{timers__win32_8cpp_b8d05dee70f04b5c5190ab00e84da106}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
\index{timers_win32.cpp@{timers\_\-win32.cpp}!setTimer@{setTimer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
\index{setTimer@{setTimer}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
\subsubsection[setTimer]{\setlength{\rightskip}{0pt plus 5cm}void set\-Timer (TIMEVAL {\em value})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\label{timers__win32_8cpp_b8d05dee70f04b5c5190ab00e84da106}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
Definition at line 233 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
References maxval, class\_\-timers::set\_\-timer(), and timer.\hypertarget{timers__win32_8cpp_c9e1731843825eb55e7a94894e6a8ec5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
\index{timers_win32.cpp@{timers\_\-win32.cpp}!StartTimerLoop@{StartTimerLoop}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
\index{StartTimerLoop@{StartTimerLoop}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
\subsubsection[StartTimerLoop]{\setlength{\rightskip}{0pt plus 5cm}void Start\-Timer\-Loop (\hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} {\em init\_\-callback})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\label{timers__win32_8cpp_c9e1731843825eb55e7a94894e6a8ec5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
Definition at line 219 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
References Enter\-Mutex(), init\-Timer(), Leave\-Mutex(), class\_\-timers::resume\_\-timer\_\-thread(), Set\-Alarm(), class\_\-timers::start\_\-timer\_\-thread(), and TIMEVAL.\hypertarget{timers__win32_8cpp_8758484f3cebb0cd44bb247c3f23d5e3}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
\index{timers_win32.cpp@{timers\_\-win32.cpp}!StopTimerLoop@{StopTimerLoop}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
\index{StopTimerLoop@{StopTimerLoop}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
\subsubsection[StopTimerLoop]{\setlength{\rightskip}{0pt plus 5cm}void Stop\-Timer\-Loop (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
\label{timers__win32_8cpp_8758484f3cebb0cd44bb247c3f23d5e3}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
Definition at line 228 of file timers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
References Enter\-Mutex(), Leave\-Mutex(), class\_\-timers::stop\_\-timer\_\-thread(), and timer.\hypertarget{timers__win32_8cpp_4b2486891ee01e06e2deead4cf963727}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
\index{timers_win32.cpp@{timers\_\-win32.cpp}!WaitReceiveTaskEnd@{WaitReceiveTaskEnd}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
\index{WaitReceiveTaskEnd@{WaitReceiveTaskEnd}!timers_win32.cpp@{timers\_\-win32.cpp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
\subsubsection[WaitReceiveTaskEnd]{\setlength{\rightskip}{0pt plus 5cm}void Wait\-Receive\-Task\-End (TASK\_\-HANDLE {\em Thread})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\label{timers__win32_8cpp_4b2486891ee01e06e2deead4cf963727}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
Definition at line 84 of file timers\_\-win32.cpp.