doc/doxygen/latex/timer_8h.tex
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{timer_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/timer.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{timer_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/timer.h@{/home/epimerde/documents/tc11/CanFestival-3/include/timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$timerscfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\subsection*{Data Structures}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
struct \hyperlink{structstruct__s__timer__entry}{struct\_\-s\_\-timer\_\-entry}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\subsection*{Defines}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\#define \hyperlink{timer_8h_146f546340de2a44ab2f63681d40de95}{TIMER\_\-HANDLE}~INTEGER16
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\subsection*{Typedefs}
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
typedef void($\ast$) \hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS32 id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
typedef \hyperlink{structstruct__s__timer__entry}{struct\_\-s\_\-timer\_\-entry} \hyperlink{timer_8h_da9472124b37d582959f8b16e6d29ffe}{s\_\-timer\_\-entry}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
TIMER\_\-HANDLE \hyperlink{timer_8h_11c2616d78f06ed9144ef662f757b128}{Set\-Alarm} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS32 id, \hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} callback, TIMEVAL value, TIMEVAL period)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
TIMER\_\-HANDLE \hyperlink{timer_8h_991b3cfaac2f201b14d5530f75985c21}{Del\-Alarm} (TIMER\_\-HANDLE handle)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
void \hyperlink{timer_8h_9e5fb60f13faab8705899c5806754864}{Time\-Dispatch} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
void \hyperlink{timer_8h_b8d05dee70f04b5c5190ab00e84da106}{set\-Timer} (TIMEVAL value)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
TIMEVAL \hyperlink{timer_8h_4dccc204d52176bd547ab34d6858f5ba}{get\-Elapsed\-Time} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\subsection{Define Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\hypertarget{timer_8h_146f546340de2a44ab2f63681d40de95}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\index{timer.h@{timer.h}!TIMER_HANDLE@{TIMER\_\-HANDLE}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\index{TIMER_HANDLE@{TIMER\_\-HANDLE}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\subsubsection[TIMER\_\-HANDLE]{\setlength{\rightskip}{0pt plus 5cm}\#define TIMER\_\-HANDLE~INTEGER16}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\label{timer_8h_146f546340de2a44ab2f63681d40de95}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
Definition at line 29 of file timer.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\hypertarget{timer_8h_da9472124b37d582959f8b16e6d29ffe}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\index{timer.h@{timer.h}!s_timer_entry@{s\_\-timer\_\-entry}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\index{s_timer_entry@{s\_\-timer\_\-entry}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\subsubsection[s\_\-timer\_\-entry]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structstruct__s__timer__entry}{struct\_\-s\_\-timer\_\-entry} \hyperlink{structstruct__s__timer__entry}{s\_\-timer\_\-entry}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\label{timer_8h_da9472124b37d582959f8b16e6d29ffe}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
Definition at line 52 of file timer.h.\hypertarget{timer_8h_f7d102e060339d3730ceae5fea03691b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\index{timer.h@{timer.h}!TimerCallback_t@{TimerCallback\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\index{TimerCallback_t@{TimerCallback\_\-t}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\subsubsection[TimerCallback\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t}(\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS32 id)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\label{timer_8h_f7d102e060339d3730ceae5fea03691b}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
Definition at line 41 of file timer.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\hypertarget{timer_8h_991b3cfaac2f201b14d5530f75985c21}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\index{timer.h@{timer.h}!DelAlarm@{DelAlarm}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{DelAlarm@{DelAlarm}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\subsubsection[DelAlarm]{\setlength{\rightskip}{0pt plus 5cm}TIMER\_\-HANDLE Del\-Alarm (TIMER\_\-HANDLE {\em handle})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\label{timer_8h_991b3cfaac2f201b14d5530f75985c21}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
Definition at line 87 of file timer.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
References last\_\-timer\_\-raw, MSG\_\-WAR, struct\_\-s\_\-timer\_\-entry::state, and timers.\hypertarget{timer_8h_4dccc204d52176bd547ab34d6858f5ba}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\index{timer.h@{timer.h}!getElapsedTime@{getElapsedTime}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{getElapsedTime@{getElapsedTime}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\subsubsection[getElapsedTime]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL get\-Elapsed\-Time (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\label{timer_8h_4dccc204d52176bd547ab34d6858f5ba}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
Definition at line 66 of file can\-Open\-Driver.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
References class\_\-timers::get\_\-elapsed\_\-time(), IO\_\-PORTS\_\-16, and TC4H.\hypertarget{timer_8h_11c2616d78f06ed9144ef662f757b128}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\index{timer.h@{timer.h}!SetAlarm@{SetAlarm}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
\index{SetAlarm@{SetAlarm}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
\subsubsection[SetAlarm]{\setlength{\rightskip}{0pt plus 5cm}TIMER\_\-HANDLE Set\-Alarm (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS32 {\em id}, \hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} {\em callback}, TIMEVAL {\em value}, TIMEVAL {\em period})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
\label{timer_8h_11c2616d78f06ed9144ef662f757b128}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
Definition at line 38 of file timer.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
References struct\_\-s\_\-timer\_\-entry::d, last\_\-timer\_\-raw, MAX\_\-NB\_\-TIMER, TIMER\_\-HANDLE, and timers.\hypertarget{timer_8h_b8d05dee70f04b5c5190ab00e84da106}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
\index{timer.h@{timer.h}!setTimer@{setTimer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
\index{setTimer@{setTimer}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
\subsubsection[setTimer]{\setlength{\rightskip}{0pt plus 5cm}void set\-Timer (TIMEVAL {\em value})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
\label{timer_8h_b8d05dee70f04b5c5190ab00e84da106}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
Definition at line 83 of file timers\_\-unix.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
References maxval, class\_\-timers::set\_\-timer(), and timer.\hypertarget{timer_8h_9e5fb60f13faab8705899c5806754864}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\index{timer.h@{timer.h}!TimeDispatch@{TimeDispatch}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
\index{TimeDispatch@{TimeDispatch}!timer.h@{timer.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\subsubsection[TimeDispatch]{\setlength{\rightskip}{0pt plus 5cm}void Time\-Dispatch (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\label{timer_8h_9e5fb60f13faab8705899c5806754864}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
Definition at line 104 of file timer.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
References get\-Elapsed\-Time(), last\_\-timer\_\-raw, min\_\-val, TIMER\_\-HANDLE, timers, TIMEVAL, TIMEVAL\_\-MAX, and total\_\-sleep\_\-time.