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