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