doc/doxygen/latex/classclass__timers.tex
changeset 207 b6572d0336c3
equal deleted inserted replaced
206:6787754b251b 207:b6572d0336c3
       
     1 \hypertarget{classclass__timers}{
       
     2 \section{class\_\-timers Class Reference}
       
     3 \label{classclass__timers}\index{class_timers@{class\_\-timers}}
       
     4 }
       
     5 \subsection*{Public Member Functions}
       
     6 \begin{CompactItemize}
       
     7 \item 
       
     8 \hyperlink{classclass__timers_924a91ae96d721dd432136351c925d9f}{class\_\-timers} ()
       
     9 \item 
       
    10 \hyperlink{classclass__timers_6fd261041314ddd3ada9537530d02afd}{$\sim$class\_\-timers} ()
       
    11 \item 
       
    12 void \hyperlink{classclass__timers_d857a63670354f41759f68d4ea29a0f5}{start\_\-timer\_\-thread} ()
       
    13 \item 
       
    14 void \hyperlink{classclass__timers_e0066fac671c6adb997d6c075487af89}{resume\_\-timer\_\-thread} ()
       
    15 \item 
       
    16 void \hyperlink{classclass__timers_a78d9f5ab159ec6b11b4dc4c8f351697}{stop\_\-timer\_\-thread} ()
       
    17 \item 
       
    18 void \hyperlink{classclass__timers_a27df6346a38fb25acc394cb7998a3f8}{set\_\-timer} (TIMEVAL value)
       
    19 \item 
       
    20 TIMEVAL \hyperlink{classclass__timers_0fa5bd5d1d4012bf9eef3ffabe990dfb}{get\_\-elapsed\_\-time} ()
       
    21 \end{CompactItemize}
       
    22 \subsection*{Private Member Functions}
       
    23 \begin{CompactItemize}
       
    24 \item 
       
    25 TIMEVAL \hyperlink{classclass__timers_e4fe19b5b56b72ce2601d74f6519bd0b}{get\_\-timer} () const
       
    26 \end{CompactItemize}
       
    27 \subsection*{Static Private Member Functions}
       
    28 \begin{CompactItemize}
       
    29 \item 
       
    30 static DWORD WINAPI \hyperlink{classclass__timers_a68dd5b6225b3519b4bc2a0280683c87}{timer\_\-loop\_\-thread\_\-proc} (void $\ast$arg)
       
    31 \end{CompactItemize}
       
    32 \subsection*{Private Attributes}
       
    33 \begin{CompactItemize}
       
    34 \item 
       
    35 TIMEVAL \hyperlink{classclass__timers_01c07cb9949b61fce137e60a54d001b9}{m\_\-last\_\-occured\_\-alarm\_\-time}
       
    36 \item 
       
    37 volatile TIMEVAL \hyperlink{classclass__timers_d45784e3a40494a35d5684ab8df0bfc9}{m\_\-last\_\-alarm\_\-set\_\-time}
       
    38 \item 
       
    39 HANDLE \hyperlink{classclass__timers_8d08585f4ba63c21b4636863499b9e05}{m\_\-timer\_\-thread}
       
    40 \item 
       
    41 volatile bool \hyperlink{classclass__timers_957a0cc71456a57fd5cb640122fe924a}{m\_\-continue\_\-timer\_\-loop}
       
    42 \item 
       
    43 bool \hyperlink{classclass__timers_5fdc6eb0abb2689d078b333b083bfcb0}{m\_\-use\_\-hi\_\-res\_\-timer}
       
    44 \item 
       
    45 double \hyperlink{classclass__timers_5bf844fdbe2e70ab6e3e832f688d382b}{m\_\-counts\_\-per\_\-usec}
       
    46 \end{CompactItemize}
       
    47 
       
    48 
       
    49 \subsection{Detailed Description}
       
    50 
       
    51 
       
    52 
       
    53 
       
    54 Definition at line 94 of file timers\_\-win32.cpp.
       
    55 
       
    56 \subsection{Constructor \& Destructor Documentation}
       
    57 \hypertarget{classclass__timers_924a91ae96d721dd432136351c925d9f}{
       
    58 \index{class_timers@{class\_\-timers}!class_timers@{class\_\-timers}}
       
    59 \index{class_timers@{class\_\-timers}!class_timers@{class\_\-timers}}
       
    60 \subsubsection[class\_\-timers]{\setlength{\rightskip}{0pt plus 5cm}class\_\-timers::class\_\-timers ()}}
       
    61 \label{classclass__timers_924a91ae96d721dd432136351c925d9f}
       
    62 
       
    63 
       
    64 
       
    65 
       
    66 Definition at line 116 of file timers\_\-win32.cpp.
       
    67 
       
    68 References m\_\-counts\_\-per\_\-usec, and m\_\-use\_\-hi\_\-res\_\-timer.\hypertarget{classclass__timers_6fd261041314ddd3ada9537530d02afd}{
       
    69 \index{class_timers@{class\_\-timers}!~class_timers@{$\sim$class\_\-timers}}
       
    70 \index{~class_timers@{$\sim$class\_\-timers}!class_timers@{class\_\-timers}}
       
    71 \subsubsection[$\sim$class\_\-timers]{\setlength{\rightskip}{0pt plus 5cm}class\_\-timers::$\sim$class\_\-timers ()}}
       
    72 \label{classclass__timers_6fd261041314ddd3ada9537530d02afd}
       
    73 
       
    74 
       
    75 
       
    76 
       
    77 Definition at line 133 of file timers\_\-win32.cpp.
       
    78 
       
    79 References stop\_\-timer\_\-thread().
       
    80 
       
    81 \subsection{Member Function Documentation}
       
    82 \hypertarget{classclass__timers_d857a63670354f41759f68d4ea29a0f5}{
       
    83 \index{class_timers@{class\_\-timers}!start_timer_thread@{start\_\-timer\_\-thread}}
       
    84 \index{start_timer_thread@{start\_\-timer\_\-thread}!class_timers@{class\_\-timers}}
       
    85 \subsubsection[start\_\-timer\_\-thread]{\setlength{\rightskip}{0pt plus 5cm}void class\_\-timers::start\_\-timer\_\-thread ()}}
       
    86 \label{classclass__timers_d857a63670354f41759f68d4ea29a0f5}
       
    87 
       
    88 
       
    89 
       
    90 
       
    91 Definition at line 173 of file timers\_\-win32.cpp.
       
    92 
       
    93 References get\_\-timer(), m\_\-last\_\-alarm\_\-set\_\-time, m\_\-last\_\-occured\_\-alarm\_\-time, m\_\-timer\_\-thread, timer\_\-loop\_\-thread\_\-proc(), and TIMEVAL\_\-MAX.\hypertarget{classclass__timers_e0066fac671c6adb997d6c075487af89}{
       
    94 \index{class_timers@{class\_\-timers}!resume_timer_thread@{resume\_\-timer\_\-thread}}
       
    95 \index{resume_timer_thread@{resume\_\-timer\_\-thread}!class_timers@{class\_\-timers}}
       
    96 \subsubsection[resume\_\-timer\_\-thread]{\setlength{\rightskip}{0pt plus 5cm}void class\_\-timers::resume\_\-timer\_\-thread ()}}
       
    97 \label{classclass__timers_e0066fac671c6adb997d6c075487af89}
       
    98 
       
    99 
       
   100 
       
   101 
       
   102 Definition at line 184 of file timers\_\-win32.cpp.
       
   103 
       
   104 References m\_\-continue\_\-timer\_\-loop, and m\_\-timer\_\-thread.\hypertarget{classclass__timers_a78d9f5ab159ec6b11b4dc4c8f351697}{
       
   105 \index{class_timers@{class\_\-timers}!stop_timer_thread@{stop\_\-timer\_\-thread}}
       
   106 \index{stop_timer_thread@{stop\_\-timer\_\-thread}!class_timers@{class\_\-timers}}
       
   107 \subsubsection[stop\_\-timer\_\-thread]{\setlength{\rightskip}{0pt plus 5cm}void class\_\-timers::stop\_\-timer\_\-thread ()}}
       
   108 \label{classclass__timers_a78d9f5ab159ec6b11b4dc4c8f351697}
       
   109 
       
   110 
       
   111 
       
   112 
       
   113 Definition at line 193 of file timers\_\-win32.cpp.
       
   114 
       
   115 References m\_\-continue\_\-timer\_\-loop, and m\_\-timer\_\-thread.\hypertarget{classclass__timers_a27df6346a38fb25acc394cb7998a3f8}{
       
   116 \index{class_timers@{class\_\-timers}!set_timer@{set\_\-timer}}
       
   117 \index{set_timer@{set\_\-timer}!class_timers@{class\_\-timers}}
       
   118 \subsubsection[set\_\-timer]{\setlength{\rightskip}{0pt plus 5cm}void class\_\-timers::set\_\-timer (TIMEVAL {\em value})}}
       
   119 \label{classclass__timers_a27df6346a38fb25acc394cb7998a3f8}
       
   120 
       
   121 
       
   122 
       
   123 
       
   124 Definition at line 204 of file timers\_\-win32.cpp.
       
   125 
       
   126 References get\_\-timer(), m\_\-last\_\-alarm\_\-set\_\-time, and TIMEVAL\_\-MAX.\hypertarget{classclass__timers_0fa5bd5d1d4012bf9eef3ffabe990dfb}{
       
   127 \index{class_timers@{class\_\-timers}!get_elapsed_time@{get\_\-elapsed\_\-time}}
       
   128 \index{get_elapsed_time@{get\_\-elapsed\_\-time}!class_timers@{class\_\-timers}}
       
   129 \subsubsection[get\_\-elapsed\_\-time]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL class\_\-timers::get\_\-elapsed\_\-time ()}}
       
   130 \label{classclass__timers_0fa5bd5d1d4012bf9eef3ffabe990dfb}
       
   131 
       
   132 
       
   133 
       
   134 
       
   135 Definition at line 210 of file timers\_\-win32.cpp.
       
   136 
       
   137 References get\_\-timer(), and m\_\-last\_\-occured\_\-alarm\_\-time.\hypertarget{classclass__timers_e4fe19b5b56b72ce2601d74f6519bd0b}{
       
   138 \index{class_timers@{class\_\-timers}!get_timer@{get\_\-timer}}
       
   139 \index{get_timer@{get\_\-timer}!class_timers@{class\_\-timers}}
       
   140 \subsubsection[get\_\-timer]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL class\_\-timers::get\_\-timer () const\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   141 \label{classclass__timers_e4fe19b5b56b72ce2601d74f6519bd0b}
       
   142 
       
   143 
       
   144 
       
   145 
       
   146 Definition at line 139 of file timers\_\-win32.cpp.
       
   147 
       
   148 References m\_\-counts\_\-per\_\-usec, m\_\-use\_\-hi\_\-res\_\-timer, and TIMEVAL.\hypertarget{classclass__timers_a68dd5b6225b3519b4bc2a0280683c87}{
       
   149 \index{class_timers@{class\_\-timers}!timer_loop_thread_proc@{timer\_\-loop\_\-thread\_\-proc}}
       
   150 \index{timer_loop_thread_proc@{timer\_\-loop\_\-thread\_\-proc}!class_timers@{class\_\-timers}}
       
   151 \subsubsection[timer\_\-loop\_\-thread\_\-proc]{\setlength{\rightskip}{0pt plus 5cm}DWORD WINAPI class\_\-timers::timer\_\-loop\_\-thread\_\-proc (void $\ast$ {\em arg})\hspace{0.3cm}{\tt  \mbox{[}static, private\mbox{]}}}}
       
   152 \label{classclass__timers_a68dd5b6225b3519b4bc2a0280683c87}
       
   153 
       
   154 
       
   155 
       
   156 
       
   157 Definition at line 151 of file timers\_\-win32.cpp.
       
   158 
       
   159 References Enter\-Mutex(), get\_\-timer(), Leave\-Mutex(), m\_\-continue\_\-timer\_\-loop, m\_\-last\_\-alarm\_\-set\_\-time, m\_\-last\_\-occured\_\-alarm\_\-time, Time\-Dispatch(), TIMEVAL, and TIMEVAL\_\-MAX.
       
   160 
       
   161 \subsection{Field Documentation}
       
   162 \hypertarget{classclass__timers_01c07cb9949b61fce137e60a54d001b9}{
       
   163 \index{class_timers@{class\_\-timers}!m_last_occured_alarm_time@{m\_\-last\_\-occured\_\-alarm\_\-time}}
       
   164 \index{m_last_occured_alarm_time@{m\_\-last\_\-occured\_\-alarm\_\-time}!class_timers@{class\_\-timers}}
       
   165 \subsubsection[m\_\-last\_\-occured\_\-alarm\_\-time]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL \hyperlink{classclass__timers_01c07cb9949b61fce137e60a54d001b9}{class\_\-timers::m\_\-last\_\-occured\_\-alarm\_\-time}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   166 \label{classclass__timers_01c07cb9949b61fce137e60a54d001b9}
       
   167 
       
   168 
       
   169 
       
   170 
       
   171 Definition at line 108 of file timers\_\-win32.cpp.\hypertarget{classclass__timers_d45784e3a40494a35d5684ab8df0bfc9}{
       
   172 \index{class_timers@{class\_\-timers}!m_last_alarm_set_time@{m\_\-last\_\-alarm\_\-set\_\-time}}
       
   173 \index{m_last_alarm_set_time@{m\_\-last\_\-alarm\_\-set\_\-time}!class_timers@{class\_\-timers}}
       
   174 \subsubsection[m\_\-last\_\-alarm\_\-set\_\-time]{\setlength{\rightskip}{0pt plus 5cm}volatile TIMEVAL \hyperlink{classclass__timers_d45784e3a40494a35d5684ab8df0bfc9}{class\_\-timers::m\_\-last\_\-alarm\_\-set\_\-time}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   175 \label{classclass__timers_d45784e3a40494a35d5684ab8df0bfc9}
       
   176 
       
   177 
       
   178 
       
   179 
       
   180 Definition at line 109 of file timers\_\-win32.cpp.\hypertarget{classclass__timers_8d08585f4ba63c21b4636863499b9e05}{
       
   181 \index{class_timers@{class\_\-timers}!m_timer_thread@{m\_\-timer\_\-thread}}
       
   182 \index{m_timer_thread@{m\_\-timer\_\-thread}!class_timers@{class\_\-timers}}
       
   183 \subsubsection[m\_\-timer\_\-thread]{\setlength{\rightskip}{0pt plus 5cm}HANDLE \hyperlink{classclass__timers_8d08585f4ba63c21b4636863499b9e05}{class\_\-timers::m\_\-timer\_\-thread}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   184 \label{classclass__timers_8d08585f4ba63c21b4636863499b9e05}
       
   185 
       
   186 
       
   187 
       
   188 
       
   189 Definition at line 110 of file timers\_\-win32.cpp.\hypertarget{classclass__timers_957a0cc71456a57fd5cb640122fe924a}{
       
   190 \index{class_timers@{class\_\-timers}!m_continue_timer_loop@{m\_\-continue\_\-timer\_\-loop}}
       
   191 \index{m_continue_timer_loop@{m\_\-continue\_\-timer\_\-loop}!class_timers@{class\_\-timers}}
       
   192 \subsubsection[m\_\-continue\_\-timer\_\-loop]{\setlength{\rightskip}{0pt plus 5cm}volatile bool \hyperlink{classclass__timers_957a0cc71456a57fd5cb640122fe924a}{class\_\-timers::m\_\-continue\_\-timer\_\-loop}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   193 \label{classclass__timers_957a0cc71456a57fd5cb640122fe924a}
       
   194 
       
   195 
       
   196 
       
   197 
       
   198 Definition at line 111 of file timers\_\-win32.cpp.\hypertarget{classclass__timers_5fdc6eb0abb2689d078b333b083bfcb0}{
       
   199 \index{class_timers@{class\_\-timers}!m_use_hi_res_timer@{m\_\-use\_\-hi\_\-res\_\-timer}}
       
   200 \index{m_use_hi_res_timer@{m\_\-use\_\-hi\_\-res\_\-timer}!class_timers@{class\_\-timers}}
       
   201 \subsubsection[m\_\-use\_\-hi\_\-res\_\-timer]{\setlength{\rightskip}{0pt plus 5cm}bool \hyperlink{classclass__timers_5fdc6eb0abb2689d078b333b083bfcb0}{class\_\-timers::m\_\-use\_\-hi\_\-res\_\-timer}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   202 \label{classclass__timers_5fdc6eb0abb2689d078b333b083bfcb0}
       
   203 
       
   204 
       
   205 
       
   206 
       
   207 Definition at line 112 of file timers\_\-win32.cpp.\hypertarget{classclass__timers_5bf844fdbe2e70ab6e3e832f688d382b}{
       
   208 \index{class_timers@{class\_\-timers}!m_counts_per_usec@{m\_\-counts\_\-per\_\-usec}}
       
   209 \index{m_counts_per_usec@{m\_\-counts\_\-per\_\-usec}!class_timers@{class\_\-timers}}
       
   210 \subsubsection[m\_\-counts\_\-per\_\-usec]{\setlength{\rightskip}{0pt plus 5cm}double \hyperlink{classclass__timers_5bf844fdbe2e70ab6e3e832f688d382b}{class\_\-timers::m\_\-counts\_\-per\_\-usec}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}
       
   211 \label{classclass__timers_5bf844fdbe2e70ab6e3e832f688d382b}
       
   212 
       
   213 
       
   214 
       
   215 
       
   216 Definition at line 113 of file timers\_\-win32.cpp.
       
   217 
       
   218 The documentation for this class was generated from the following file:\begin{CompactItemize}
       
   219 \item 
       
   220 /home/epimerde/documents/tc11/Can\-Festival-3/drivers/win32/\hyperlink{timers__win32_8cpp}{timers\_\-win32.cpp}\end{CompactItemize}