diff -r 003cc3c63855 -r f49e5a6b7804 doc/doxygen/html/objacces_8h.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/doxygen/html/objacces_8h.html Fri Jun 08 09:23:56 2007 +0200 @@ -0,0 +1,582 @@ + + +CanFestival: include/objacces.h File Reference + + + + +
+
+
+
+
+include
+

objacces.h File Reference

Responsible for accessing the object dictionary. More... +

+#include <applicfg.h>
+#include "data.h"
+ +

+Include dependency graph for objacces.h:

+ + + + + + + + + + + + + + + + + +

+This graph shows which files directly or indirectly include this file:

+ + + + + + + + +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + +

Typedefs

typedef UNS32(*) valueRangeTest_t (UNS8 typeValue, void *Value)
typedef void(*) storeODSubIndex_t (UNS16 wIndex, UNS8 bSubindex)

Functions

void _storeODSubIndex (UNS16 wIndex, UNS8 bSubindex)
UNS8 accessDictionaryError (UNS16 index, UNS8 subIndex, UNS8 sizeDataDict, UNS8 sizeDataGiven, UNS32 code)
UNS32 getODentry (CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pDestData, UNS8 *pExpectedSize, UNS8 *pDataType, UNS8 checkAccess)
UNS32 setODentry (CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)
UNS32 writeLocalDict (CO_Data *d, UNS16 wIndex, UNS8 bSubindex, void *pSourceData, UNS8 *pExpectedSize, UNS8 checkAccess)
const indextable * scanIndexOD (CO_Data *d, UNS16 wIndex, UNS32 *errorCode, ODCallback_t **Callback)
UNS32 RegisterSetODentryCallBack (CO_Data *d, UNS16 wIndex, UNS8 bSubindex, ODCallback_t Callback)
+

Detailed Description

+Responsible for accessing the object dictionary. +

+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

Warning:
Only the basic entries of an object dictionary are included at the moment.
+ +

+Definition in file objacces.h.

Typedef Documentation

+ +
+
+ + + + +
typedef void(* ) storeODSubIndex_t(UNS16 wIndex, UNS8 bSubindex)
+
+
+ +

+ +

+Definition at line 40 of file objacces.h. +

+

+ +

+
+ + + + +
typedef UNS32(*) valueRangeTest_t(UNS8 typeValue, void *Value)
+
+
+ +

+ +

+Definition at line 39 of file objacces.h. +

+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void _storeODSubIndex (UNS16  wIndex,
UNS8  bSubindex 
)
+
+
+ +

+

Parameters:
+ + + +
wIndex 
bSubindex 
+
+ +

+Definition at line 436 of file objacces.c. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 accessDictionaryError (UNS16  index,
UNS8  subIndex,
UNS8  sizeDataDict,
UNS8  sizeDataGiven,
UNS32  code 
)
+
+
+ +

+

Parameters:
+ + + + + + +
index 
subIndex 
sizeDataDict 
sizeDataGiven 
code 
+
+
Returns:
+ +

+Definition at line 55 of file objacces.c. +

+References MSG_WAR, OD_LENGTH_DATA_INVALID, OD_NO_SUCH_OBJECT, OD_NO_SUCH_SUBINDEX, OD_NOT_MAPPABLE, OD_VALUE_TOO_HIGH, OD_VALUE_TOO_LOW, and OD_WRITE_NOT_ALLOWED. +

+Referenced by _getODentry(), and _setODentry(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS32 getODentry (CO_Data *  d,
UNS16  wIndex,
UNS8  bSubindex,
void *  pDestData,
UNS8 *  pExpectedSize,
UNS8 *  pDataType,
UNS8  checkAccess 
)
+
+
+ +

+

Parameters:
+ + + + + + + + +
d 
wIndex 
bSubindex 
pDestData 
pExpectedSize 
pDataType 
checkAccess 
+
+
Returns:
+ +

+Definition at line 198 of file objacces.c. +

+References _getODentry(), and struct_s_timer_entry::d. +

+Referenced by objdictToSDOline(), proceedPDO(), and proceedSYNC(). +

+Here is the call graph for this function:

+ + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS32 RegisterSetODentryCallBack (CO_Data *  d,
UNS16  wIndex,
UNS8  bSubindex,
ODCallback_t  Callback 
)
+
+
+ +

+

Parameters:
+ + + + + +
d 
wIndex 
bSubindex 
Callback 
+
+
Returns:
+ +

+Definition at line 419 of file objacces.c. +

+References struct_s_timer_entry::d, OD_SUCCESSFUL, scanIndexOD(), and UNS32. +

+Referenced by heartbeatInit(), InitNodes(), and startSYNC(). +

+Here is the call graph for this function:

+ + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const indextable* scanIndexOD (CO_Data *  d,
UNS16  wIndex,
UNS32 *  errorCode,
ODCallback_t **  Callback 
)
+
+
+ +

+

Parameters:
+ + + + + +
d 
wIndex 
errorCode 
Callback 
+
+
Returns:
+ +

+Definition at line 404 of file objacces.c. +

+References struct_s_timer_entry::d, and struct_CO_Data::scanIndexOD. +

+Referenced by RegisterSetODentryCallBack(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS32 setODentry (CO_Data *  d,
UNS16  wIndex,
UNS8  bSubindex,
void *  pSourceData,
UNS8 *  pExpectedSize,
UNS8  checkAccess 
)
+
+
+ +

+

Parameters:
+ + + + + + + +
d 
wIndex 
bSubindex 
pSourceData 
pExpectedSize 
checkAccess 
+
+
Returns:
+ +

+Definition at line 350 of file objacces.c. +

+References _setODentry(), and struct_s_timer_entry::d. +

+Referenced by proceedPDO(), and SDOlineToObjdict(). +

+Here is the call graph for this function:

+ + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS32 writeLocalDict (CO_Data *  d,
UNS16  wIndex,
UNS8  bSubindex,
void *  pSourceData,
UNS8 *  pExpectedSize,
UNS8  checkAccess 
)
+
+
+ +

+

Parameters:
+ + + + + + + +
d 
wIndex 
bSubindex 
pSourceData 
pExpectedSize 
checkAccess 
+
+
Returns:
+ +

+Definition at line 378 of file objacces.c. +

+References _setODentry(), and struct_s_timer_entry::d. +

+Referenced by main(), and TestMaster_initialisation(). +

+Here is the call graph for this function:

+ + + + + +
+

+

Generated on Fri Jun 8 08:52:01 2007 for CanFestival by  + +doxygen 1.5.1
+ +