doc/doxygen/latex/objacces_8h.tex
author nico
Thu, 07 Jun 2007 09:03:41 +0200
changeset 213 1df3055de547
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{objacces_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/objacces.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{objacces_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/objacces.h@{/home/epimerde/documents/tc11/CanFestival-3/include/objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
Responsible for accessing the object dictionary. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
typedef UNS32($\ast$) \hyperlink{objacces_8h_270e94e9acf61da8b2f36b3ebdbf2fdd}{value\-Range\-Test\_\-t} (UNS8 type\-Value, void $\ast$Value)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
typedef void($\ast$) \hyperlink{objacces_8h_7b55b55a3f5ed8e4b2991cb85c7be7ce}{store\-ODSub\-Index\_\-t} (UNS16 w\-Index, UNS8 b\-Subindex)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
void \hyperlink{objacces_8h_43bf8d2616cf3d7d713b4af3d33a139c}{\_\-store\-ODSub\-Index} (UNS16 w\-Index, UNS8 b\-Subindex)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
UNS8 \hyperlink{objacces_8h_75d39b2dadcdb48f7321c6f3766aad26}{access\-Dictionary\-Error} (UNS16 index, UNS8 sub\-Index, UNS8 size\-Data\-Dict, UNS8 size\-Data\-Given, UNS32 code)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
UNS32 \hyperlink{objacces_8h_39c263a4bc5d2d824fefe22fdb4c2dac}{get\-ODentry} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS16 w\-Index, UNS8 b\-Subindex, void $\ast$p\-Dest\-Data, UNS8 $\ast$p\-Expected\-Size, UNS8 $\ast$p\-Data\-Type, UNS8 check\-Access)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
UNS32 \hyperlink{objacces_8h_17e598cc1b2e60380e2e4e75afe9b3b0}{set\-ODentry} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS16 w\-Index, UNS8 b\-Subindex, void $\ast$p\-Source\-Data, UNS8 $\ast$p\-Expected\-Size, UNS8 check\-Access)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
UNS32 \hyperlink{objacces_8h_7cc58d6e7711bd0d9fd75e8ff721ce36}{write\-Local\-Dict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS16 w\-Index, UNS8 b\-Subindex, void $\ast$p\-Source\-Data, UNS8 $\ast$p\-Expected\-Size, UNS8 check\-Access)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
const \hyperlink{structtd__indextable}{indextable} $\ast$ \hyperlink{objacces_8h_11e9f24840d05a6a622955b51f91af53}{scan\-Index\-OD} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS16 w\-Index, UNS32 $\ast$error\-Code, \hyperlink{objdictdef_8h_91481b154cacc926ae5824fd121d6b43}{ODCallback\_\-t} $\ast$$\ast$Callback)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
UNS32 \hyperlink{objacces_8h_514e7b9c13835a86446b1cd38fa34049}{Register\-Set\-ODentry\-Call\-Back} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS16 w\-Index, UNS8 b\-Subindex, \hyperlink{objdictdef_8h_91481b154cacc926ae5824fd121d6b43}{ODCallback\_\-t} Callback)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\subsection{Detailed Description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
Responsible for accessing the object dictionary. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
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 \begin{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\item[Warning:]Only the basic entries of an object dictionary are included at the moment. \end{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
Definition in file \hyperlink{objacces_8h-source}{objacces.h}.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\hypertarget{objacces_8h_7b55b55a3f5ed8e4b2991cb85c7be7ce}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\index{objacces.h@{objacces.h}!storeODSubIndex_t@{storeODSubIndex\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\index{storeODSubIndex_t@{storeODSubIndex\_\-t}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\subsubsection[storeODSubIndex\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$ ) \hyperlink{objacces_8h_7b55b55a3f5ed8e4b2991cb85c7be7ce}{store\-ODSub\-Index\_\-t}(UNS16 w\-Index, UNS8 b\-Subindex)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
\label{objacces_8h_7b55b55a3f5ed8e4b2991cb85c7be7ce}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
Definition at line 40 of file objacces.h.\hypertarget{objacces_8h_270e94e9acf61da8b2f36b3ebdbf2fdd}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\index{objacces.h@{objacces.h}!valueRangeTest_t@{valueRangeTest\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\index{valueRangeTest_t@{valueRangeTest\_\-t}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\subsubsection[valueRangeTest\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef UNS32($\ast$) \hyperlink{objacces_8h_270e94e9acf61da8b2f36b3ebdbf2fdd}{value\-Range\-Test\_\-t}(UNS8 type\-Value, void $\ast$Value)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
\label{objacces_8h_270e94e9acf61da8b2f36b3ebdbf2fdd}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
Definition at line 39 of file objacces.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\hypertarget{objacces_8h_43bf8d2616cf3d7d713b4af3d33a139c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\index{objacces.h@{objacces.h}!_storeODSubIndex@{\_\-storeODSubIndex}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\index{_storeODSubIndex@{\_\-storeODSubIndex}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\subsubsection[\_\-storeODSubIndex]{\setlength{\rightskip}{0pt plus 5cm}void \_\-store\-ODSub\-Index (UNS16 {\em w\-Index}, UNS8 {\em b\-Subindex})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
\label{objacces_8h_43bf8d2616cf3d7d713b4af3d33a139c}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
Definition at line 308 of file objacces.c.\hypertarget{objacces_8h_75d39b2dadcdb48f7321c6f3766aad26}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{objacces.h@{objacces.h}!accessDictionaryError@{accessDictionaryError}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\index{accessDictionaryError@{accessDictionaryError}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\subsubsection[accessDictionaryError]{\setlength{\rightskip}{0pt plus 5cm}UNS8 access\-Dictionary\-Error (UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em size\-Data\-Dict}, UNS8 {\em size\-Data\-Given}, UNS32 {\em code})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\label{objacces_8h_75d39b2dadcdb48f7321c6f3766aad26}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
Definition at line 31 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
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.\hypertarget{objacces_8h_39c263a4bc5d2d824fefe22fdb4c2dac}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{objacces.h@{objacces.h}!getODentry@{getODentry}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\index{getODentry@{getODentry}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\subsubsection[getODentry]{\setlength{\rightskip}{0pt plus 5cm}UNS32 get\-ODentry (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS16 {\em w\-Index}, UNS8 {\em b\-Subindex}, void $\ast$ {\em p\-Dest\-Data}, UNS8 $\ast$ {\em p\-Expected\-Size}, UNS8 $\ast$ {\em p\-Data\-Type}, UNS8 {\em check\-Access})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\label{objacces_8h_39c263a4bc5d2d824fefe22fdb4c2dac}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
Definition at line 145 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
References \_\-get\-ODentry(), and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{objacces_8h_514e7b9c13835a86446b1cd38fa34049}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
\index{objacces.h@{objacces.h}!RegisterSetODentryCallBack@{RegisterSetODentryCallBack}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
\index{RegisterSetODentryCallBack@{RegisterSetODentryCallBack}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
\subsubsection[RegisterSetODentryCallBack]{\setlength{\rightskip}{0pt plus 5cm}UNS32 Register\-Set\-ODentry\-Call\-Back (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS16 {\em w\-Index}, UNS8 {\em b\-Subindex}, \hyperlink{objdictdef_8h_91481b154cacc926ae5824fd121d6b43}{ODCallback\_\-t} {\em Callback})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
\label{objacces_8h_514e7b9c13835a86446b1cd38fa34049}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
Definition at line 297 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
References struct\_\-s\_\-timer\_\-entry::d, OD\_\-SUCCESSFUL, scan\-Index\-OD(), and UNS32.\hypertarget{objacces_8h_11e9f24840d05a6a622955b51f91af53}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
\index{objacces.h@{objacces.h}!scanIndexOD@{scanIndexOD}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
\index{scanIndexOD@{scanIndexOD}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
\subsubsection[scanIndexOD]{\setlength{\rightskip}{0pt plus 5cm}const \hyperlink{structtd__indextable}{indextable}$\ast$ scan\-Index\-OD (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS16 {\em w\-Index}, UNS32 $\ast$ {\em error\-Code}, \hyperlink{objdictdef_8h_91481b154cacc926ae5824fd121d6b43}{ODCallback\_\-t} $\ast$$\ast$ {\em Callback})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
\label{objacces_8h_11e9f24840d05a6a622955b51f91af53}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
Definition at line 292 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
References struct\_\-s\_\-timer\_\-entry::d, and struct\_\-CO\_\-Data::scan\-Index\-OD.\hypertarget{objacces_8h_17e598cc1b2e60380e2e4e75afe9b3b0}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
\index{objacces.h@{objacces.h}!setODentry@{setODentry}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\index{setODentry@{setODentry}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\subsubsection[setODentry]{\setlength{\rightskip}{0pt plus 5cm}UNS32 set\-ODentry (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS16 {\em w\-Index}, UNS8 {\em b\-Subindex}, void $\ast$ {\em p\-Source\-Data}, UNS8 $\ast$ {\em p\-Expected\-Size}, UNS8 {\em check\-Access})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
\label{objacces_8h_17e598cc1b2e60380e2e4e75afe9b3b0}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
Definition at line 257 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
References \_\-set\-ODentry(), and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{objacces_8h_7cc58d6e7711bd0d9fd75e8ff721ce36}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
\index{objacces.h@{objacces.h}!writeLocalDict@{writeLocalDict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
\index{writeLocalDict@{writeLocalDict}!objacces.h@{objacces.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
\subsubsection[writeLocalDict]{\setlength{\rightskip}{0pt plus 5cm}UNS32 write\-Local\-Dict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS16 {\em w\-Index}, UNS8 {\em b\-Subindex}, void $\ast$ {\em p\-Source\-Data}, UNS8 $\ast$ {\em p\-Expected\-Size}, UNS8 {\em check\-Access})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134
\label{objacces_8h_7cc58d6e7711bd0d9fd75e8ff721ce36}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   135
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   136
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   137
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   138
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   139
Definition at line 273 of file objacces.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   140
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   141
References \_\-set\-ODentry(), and struct\_\-s\_\-timer\_\-entry::d.