coelner/gnuk
1
0
Fork 0
mirror of https://salsa.debian.org/gnuk-team/gnuk/gnuk.git synced 2024-09-21 11:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
41272c2ab7
gnuk/ChibiOS_2.0.8/docs/html/classchibios__rt_1_1_timer.html
NIIBE Yutaka c560d0ad0c import ChibiOS 2.0.8
2010-11-30 13:54:43 +09:00

224 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: chibios_rt::Timer Class Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><b>chibios_rt</b> </li>
<li><a class="el" href="classchibios__rt_1_1_timer.html">chibios_rt::Timer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>chibios_rt::Timer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="chibios_rt::Timer" -->
<p><a class="el" href="classchibios__rt_1_1_timer.html" title="Timer class.">Timer</a> class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ch_8hpp_source.html">ch.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_timer.html#a375cb7ce8108c24336016a94efd8a787">Set</a> (<a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time, <a class="el" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2">vtfunc_t</a> vtfunc, void *par)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Starts the timer. <a href="#a375cb7ce8108c24336016a94efd8a787"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_timer.html#a065b7fbc2a055152c39505ae91ea9754">Reset</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets the timer. <a href="#a065b7fbc2a055152c39505ae91ea9754"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_timer.html#a97e29d53a4aaf2ef997732be63fdee6e">IsArmed</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the timer status. <a href="#a97e29d53a4aaf2ef997732be63fdee6e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__time.html#ga56e290c9d94c0d1888c09df6af39c74a">struct::VirtualTimer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270">timer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Embedded <code><a class="el" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a></code> structure. <a href="#a0b126ef3347ec88a54c11e10070d4270"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classchibios__rt_1_1_timer.html" title="Timer class.">Timer</a> class. </p>
<p>Definition at line <a class="el" href="ch_8hpp_source.html#l00081">81</a> of file <a class="el" href="ch_8hpp_source.html">ch.hpp</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a375cb7ce8108c24336016a94efd8a787"></a><!-- doxytag: member="chibios_rt::Timer::Set" ref="a375cb7ce8108c24336016a94efd8a787" args="(systime_t time, vtfunc_t vtfunc, void *par)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Timer::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>&nbsp;</td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2">vtfunc_t</a>&nbsp;</td>
<td class="paramname"> <em>vtfunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>par</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts the timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time</em>&nbsp;</td><td>the time in system ticks </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vtfunc</em>&nbsp;</td><td>the timer callback function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>par</em>&nbsp;</td><td>the parameter for the callback function </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>It must be called with the interrupts disabled. </dd>
<dd>
The associated function is invoked by an interrupt handler. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00062">62</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e">chVTSetI()</a>, and <a class="el" href="classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270">timer</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_timer_a375cb7ce8108c24336016a94efd8a787_cgraph.png" border="0" usemap="#classchibios__rt_1_1_timer_a375cb7ce8108c24336016a94efd8a787_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_timer_a375cb7ce8108c24336016a94efd8a787_cgraph" id="classchibios__rt_1_1_timer_a375cb7ce8108c24336016a94efd8a787_cgraph">
<area shape="rect" id="node3" href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e" title="Enables a virtual timer." alt="" coords="176,5,243,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a065b7fbc2a055152c39505ae91ea9754"></a><!-- doxytag: member="chibios_rt::Timer::Reset" ref="a065b7fbc2a055152c39505ae91ea9754" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Timer::Reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the timer. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>It must be called with the interrupts disabled. </dd>
<dd>
The timer MUST be active when this function is invoked. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00067">67</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__time.html#ga680d851a74e594cc965101e79891840f">chVTResetI()</a>, and <a class="el" href="classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270">timer</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_timer_a065b7fbc2a055152c39505ae91ea9754_cgraph.png" border="0" usemap="#classchibios__rt_1_1_timer_a065b7fbc2a055152c39505ae91ea9754_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_timer_a065b7fbc2a055152c39505ae91ea9754_cgraph" id="classchibios__rt_1_1_timer_a065b7fbc2a055152c39505ae91ea9754_cgraph">
<area shape="rect" id="node3" href="group__time.html#ga680d851a74e594cc965101e79891840f" title="Disables a Virtual Timer." alt="" coords="191,5,268,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a97e29d53a4aaf2ef997732be63fdee6e"></a><!-- doxytag: member="chibios_rt::Timer::IsArmed" ref="a97e29d53a4aaf2ef997732be63fdee6e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool chibios_rt::Timer::IsArmed </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the timer status. </p>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>TRUE</em>&nbsp;</td><td>The timer is armed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>FALSE</em>&nbsp;</td><td>The timer already fired its callback. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00072">72</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__time.html#gae54e6dd40bc7b9cdeb409393ec9e134a">chVTIsArmedI</a>, and <a class="el" href="classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270">timer</a>.</p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a0b126ef3347ec88a54c11e10070d4270"></a><!-- doxytag: member="chibios_rt::Timer::timer" ref="a0b126ef3347ec88a54c11e10070d4270" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ::<a class="el" href="struct_virtual_timer.html">VirtualTimer</a> <a class="el" href="classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270">chibios_rt::Timer::timer</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Embedded <code><a class="el" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a></code> structure. </p>
<p>Definition at line <a class="el" href="ch_8hpp_source.html#l00086">86</a> of file <a class="el" href="ch_8hpp_source.html">ch.hpp</a>.</p>
<p>Referenced by <a class="el" href="classchibios__rt_1_1_timer.html#a97e29d53a4aaf2ef997732be63fdee6e">IsArmed()</a>, <a class="el" href="classchibios__rt_1_1_timer.html#a065b7fbc2a055152c39505ae91ea9754">Reset()</a>, and <a class="el" href="classchibios__rt_1_1_timer.html#a375cb7ce8108c24336016a94efd8a787">Set()</a>.</p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:59 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink