--- a/doc/doxygen/html/objacces_8h.html Tue Jun 05 17:34:33 2007 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,444 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>CanFestival: /home/epimerde/documents/tc11/CanFestival-3/include/objacces.h File Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-<link href="tabs.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.5.1 -->
-<div class="tabs">
- <ul>
- <li><a href="main.html"><span>Main Page</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li id="current"><a href="files.html"><span>Files</span></a></li>
- </ul></div>
-<div class="tabs">
- <ul>
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul></div>
-<h1>/home/epimerde/documents/tc11/CanFestival-3/include/objacces.h File Reference</h1>Responsible for accessing the object dictionary. <a href="#_details">More...</a>
-<p>
-<code>#include <<a class="el" href="win32_2applicfg_8h-source.html">applicfg.h</a>></code><br>
-<code>#include "<a class="el" href="data_8h-source.html">data.h</a>"</code><br>
-
-<p>
-<a href="objacces_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
-<tr><td></td></tr>
-<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef UNS32(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#270e94e9acf61da8b2f36b3ebdbf2fdd">valueRangeTest_t</a> (UNS8 typeValue, void *Value)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#7b55b55a3f5ed8e4b2991cb85c7be7ce">storeODSubIndex_t</a> (UNS16 wIndex, UNS8 bSubindex)</td></tr>
-
-<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#43bf8d2616cf3d7d713b4af3d33a139c">_storeODSubIndex</a> (UNS16 wIndex, UNS8 bSubindex)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8 </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#75d39b2dadcdb48f7321c6f3766aad26">accessDictionaryError</a> (UNS16 index, UNS8 subIndex, UNS8 sizeDataDict, UNS8 sizeDataGiven, UNS32 code)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS32 </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#39c263a4bc5d2d824fefe22fdb4c2dac">getODentry</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS16 wIndex, UNS8 bSubindex, void *pDestData, UNS8 *pExpectedSize, UNS8 *pDataType, UNS8 checkAccess)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS32 </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#17e598cc1b2e60380e2e4e75afe9b3b0">setODentry</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS32 </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#7cc58d6e7711bd0d9fd75e8ff721ce36">writeLocalDict</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structtd__indextable.html">indextable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#11e9f24840d05a6a622955b51f91af53">scanIndexOD</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS16 wIndex, UNS32 *errorCode, <a class="el" href="objdictdef_8h.html#91481b154cacc926ae5824fd121d6b43">ODCallback_t</a> **Callback)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS32 </td><td class="memItemRight" valign="bottom"><a class="el" href="objacces_8h.html#514e7b9c13835a86446b1cd38fa34049">RegisterSetODentryCallBack</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS16 wIndex, UNS8 bSubindex, <a class="el" href="objdictdef_8h.html#91481b154cacc926ae5824fd121d6b43">ODCallback_t</a> Callback)</td></tr>
-
-</table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-Responsible for accessing the object dictionary.
-<p>
-This file contains functions for accessing the object dictionary and variables that are contained by the object dictionary. Accessing the object dictionary contains setting local variables as PDOs and accessing (read/write) all entries of the object dictionary <dl class="warning" compact><dt><b>Warning:</b></dt><dd>Only the basic entries of an object dictionary are included at the moment. </dd></dl>
-
-<p>
-Definition in file <a class="el" href="objacces_8h-source.html">objacces.h</a>.<hr><h2>Typedef Documentation</h2>
-<a class="anchor" name="7b55b55a3f5ed8e4b2991cb85c7be7ce"></a><!-- doxytag: member="objacces.h::storeODSubIndex_t" ref="7b55b55a3f5ed8e4b2991cb85c7be7ce" args="(UNS16 wIndex, UNS8 bSubindex)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef void(* ) <a class="el" href="objacces_8h.html#7b55b55a3f5ed8e4b2991cb85c7be7ce">storeODSubIndex_t</a>(UNS16 wIndex, UNS8 bSubindex) </td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8h-source.html#l00040">40</a> of file <a class="el" href="objacces_8h-source.html">objacces.h</a>.
-</div>
-</div><p>
-<a class="anchor" name="270e94e9acf61da8b2f36b3ebdbf2fdd"></a><!-- doxytag: member="objacces.h::valueRangeTest_t" ref="270e94e9acf61da8b2f36b3ebdbf2fdd" args="(UNS8 typeValue, void *Value)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef UNS32(*) <a class="el" href="objacces_8h.html#270e94e9acf61da8b2f36b3ebdbf2fdd">valueRangeTest_t</a>(UNS8 typeValue, void *Value) </td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8h-source.html#l00039">39</a> of file <a class="el" href="objacces_8h-source.html">objacces.h</a>.
-</div>
-</div><p>
-<hr><h2>Function Documentation</h2>
-<a class="anchor" name="43bf8d2616cf3d7d713b4af3d33a139c"></a><!-- doxytag: member="objacces.h::_storeODSubIndex" ref="43bf8d2616cf3d7d713b4af3d33a139c" args="(UNS16 wIndex, UNS8 bSubindex)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void _storeODSubIndex </td>
- <td>(</td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>bSubindex</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00308">308</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-</div>
-</div><p>
-<a class="anchor" name="75d39b2dadcdb48f7321c6f3766aad26"></a><!-- doxytag: member="objacces.h::accessDictionaryError" ref="75d39b2dadcdb48f7321c6f3766aad26" args="(UNS16 index, UNS8 subIndex, UNS8 sizeDataDict, UNS8 sizeDataGiven, UNS32 code)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UNS8 accessDictionaryError </td>
- <td>(</td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>subIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>sizeDataDict</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>sizeDataGiven</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS32 </td>
- <td class="paramname"> <em>code</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00031">31</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="hcs12_2applicfg_8h-source.html#l00190">MSG_WAR</a>, <a class="el" href="def_8h-source.html#l00036">OD_LENGTH_DATA_INVALID</a>, <a class="el" href="def_8h-source.html#l00034">OD_NO_SUCH_OBJECT</a>, <a class="el" href="def_8h-source.html#l00037">OD_NO_SUCH_SUBINDEX</a>, <a class="el" href="def_8h-source.html#l00035">OD_NOT_MAPPABLE</a>, <a class="el" href="def_8h-source.html#l00039">OD_VALUE_TOO_HIGH</a>, <a class="el" href="def_8h-source.html#l00038">OD_VALUE_TOO_LOW</a>, and <a class="el" href="def_8h-source.html#l00033">OD_WRITE_NOT_ALLOWED</a>.
-</div>
-</div><p>
-<a class="anchor" name="39c263a4bc5d2d824fefe22fdb4c2dac"></a><!-- doxytag: member="objacces.h::getODentry" ref="39c263a4bc5d2d824fefe22fdb4c2dac" args="(CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pDestData, UNS8 *pExpectedSize, UNS8 *pDataType, UNS8 checkAccess)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UNS32 getODentry </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
- <td class="paramname"> <em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>bSubindex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"> <em>pDestData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 * </td>
- <td class="paramname"> <em>pExpectedSize</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 * </td>
- <td class="paramname"> <em>pDataType</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>checkAccess</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00145">145</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="objacces_8c-source.html#l00068">_getODentry()</a>, and <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>.
-</div>
-</div><p>
-<a class="anchor" name="514e7b9c13835a86446b1cd38fa34049"></a><!-- doxytag: member="objacces.h::RegisterSetODentryCallBack" ref="514e7b9c13835a86446b1cd38fa34049" args="(CO_Data *d, UNS16 wIndex, UNS8 bSubindex, ODCallback_t Callback)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UNS32 RegisterSetODentryCallBack </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
- <td class="paramname"> <em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>bSubindex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="objdictdef_8h.html#91481b154cacc926ae5824fd121d6b43">ODCallback_t</a> </td>
- <td class="paramname"> <em>Callback</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00297">297</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="def_8h-source.html#l00031">OD_SUCCESSFUL</a>, <a class="el" href="objacces_8c-source.html#l00292">scanIndexOD()</a>, and <a class="el" href="hcs12_2applicfg_8h-source.html#l00141">UNS32</a>.
-</div>
-</div><p>
-<a class="anchor" name="11e9f24840d05a6a622955b51f91af53"></a><!-- doxytag: member="objacces.h::scanIndexOD" ref="11e9f24840d05a6a622955b51f91af53" args="(CO_Data *d, UNS16 wIndex, UNS32 *errorCode, ODCallback_t **Callback)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="structtd__indextable.html">indextable</a>* scanIndexOD </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
- <td class="paramname"> <em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS32 * </td>
- <td class="paramname"> <em>errorCode</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="objdictdef_8h.html#91481b154cacc926ae5824fd121d6b43">ODCallback_t</a> ** </td>
- <td class="paramname"> <em>Callback</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00292">292</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, and <a class="el" href="data_8h-source.html#l00091">struct_CO_Data::scanIndexOD</a>.
-</div>
-</div><p>
-<a class="anchor" name="17e598cc1b2e60380e2e4e75afe9b3b0"></a><!-- doxytag: member="objacces.h::setODentry" ref="17e598cc1b2e60380e2e4e75afe9b3b0" args="(CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UNS32 setODentry </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
- <td class="paramname"> <em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>bSubindex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"> <em>pSourceData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 * </td>
- <td class="paramname"> <em>pExpectedSize</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>checkAccess</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00257">257</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="objacces_8c-source.html#l00181">_setODentry()</a>, and <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>.
-</div>
-</div><p>
-<a class="anchor" name="7cc58d6e7711bd0d9fd75e8ff721ce36"></a><!-- doxytag: member="objacces.h::writeLocalDict" ref="7cc58d6e7711bd0d9fd75e8ff721ce36" args="(CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)" -->
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UNS32 writeLocalDict </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
- <td class="paramname"> <em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS16 </td>
- <td class="paramname"> <em>wIndex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>bSubindex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"> <em>pSourceData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 * </td>
- <td class="paramname"> <em>pExpectedSize</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">UNS8 </td>
- <td class="paramname"> <em>checkAccess</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td width="100%"></td>
- </tr>
- </table>
-</div>
-<div class="memdoc">
-
-<p>
-
-<p>
-Definition at line <a class="el" href="objacces_8c-source.html#l00273">273</a> of file <a class="el" href="objacces_8c-source.html">objacces.c</a>.
-<p>
-References <a class="el" href="objacces_8c-source.html#l00181">_setODentry()</a>, and <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>.
-</div>
-</div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 4 16:29:07 2007 for CanFestival by
-<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
-</body>
-</html>