doc/doxygen/latex/states_8c.tex

   1 \hypertarget{states_8c}{
   2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/src/states.c File Reference}
   3 \label{states_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/src/states.c@{/home/epimerde/documents/tc11/CanFestival-3/src/states.c}}
   4 }
   5 {\tt \#include \char`\"{}states.h\char`\"{}}\par
   6 {\tt \#include \char`\"{}def.h\char`\"{}}\par
   7 {\tt \#include \char`\"{}dcf.h\char`\"{}}\par
   8 {\tt \#include \char`\"{}nmt\-Slave.h\char`\"{}}\par
   9 \subsection*{Defines}
  10 \begin{CompactItemize}
  11 \item
  12 \#define \hyperlink{states_8c_3a7cf0c586b1e467e6215396e9a439ae}{Start\-Or\-Stop}(Comm\-Type, Func\-Start, Func\-Stop)
  13 \item
  14 \#define \hyperlink{states_8c_f4e8bc2d192090ff502229b33c24a389}{None}
  15 \end{CompactItemize}
  16 \subsection*{Functions}
  17 \begin{CompactItemize}
  18 \item
  19 void \hyperlink{states_8c_915991eebf7c2ac6c929c6c9cfbd7d03}{switch\-Communication\-State} (CO\_\-Data $\ast$d, s\_\-state\_\-communication $\ast$new\-Communication\-State)
  20 \item
  21 e\_\-node\-State \hyperlink{states_8c_95d835785ba564bf6d92e3224c5e3848}{get\-State} (CO\_\-Data $\ast$d)
  22 \item
  23 void \hyperlink{states_8c_3f8975650604cc23582f19a43fd4e518}{can\-Dispatch} (CO\_\-Data $\ast$d, Message $\ast$m)
  24 \item
  25 UNS8 \hyperlink{states_8c_0a5004efd1dedbee82a4f21ec5c44fb5}{set\-State} (CO\_\-Data $\ast$d, e\_\-node\-State new\-State)
  26 \item
  27 UNS8 \hyperlink{states_8c_3020f2e5762f6e389a21382ec827b6a6}{get\-Node\-Id} (CO\_\-Data $\ast$d)
  28 \item
  29 void \hyperlink{states_8c_d47a53979b9311a374d029f7923abbe1}{set\-Node\-Id} (CO\_\-Data $\ast$d, UNS8 node\-Id)
  30 \item
  31 void \hyperlink{states_8c_1ee4d5c3d5dc6f39607d414b7bf9bcc9}{\_\-initialisation} ()
  32 \item
  33 void \hyperlink{states_8c_00113c22ed3366ee552f77862241d317}{\_\-pre\-Operational} ()
  34 \item
  35 void \hyperlink{states_8c_4c917142acca702f7e04e919a0b958b4}{\_\-operational} ()
  36 \item
  37 void \hyperlink{states_8c_244e9269c323e14509bea947c2729a13}{\_\-stopped} ()
  38 \end{CompactItemize}
  39
  40
  41 \subsection{Define Documentation}
  42 \hypertarget{states_8c_f4e8bc2d192090ff502229b33c24a389}{
  43 \index{states.c@{states.c}!None@{None}}
  44 \index{None@{None}!states.c@{states.c}}
  45 \subsubsection[None]{\setlength{\rightskip}{0pt plus 5cm}\#define None}}
  46 \label{states_8c_f4e8bc2d192090ff502229b33c24a389}
  47
  48
  49
  50
  51 Definition at line 86 of file states.c.\hypertarget{states_8c_3a7cf0c586b1e467e6215396e9a439ae}{
  52 \index{states.c@{states.c}!StartOrStop@{StartOrStop}}
  53 \index{StartOrStop@{StartOrStop}!states.c@{states.c}}
  54 \subsubsection[StartOrStop]{\setlength{\rightskip}{0pt plus 5cm}\#define Start\-Or\-Stop(Comm\-Type, Func\-Start, Func\-Stop)}}
  55 \label{states_8c_3a7cf0c586b1e467e6215396e9a439ae}
  56
  57
  58 \textbf{Value:}
  59
  60 \begin{Code}\begin{verbatim}if(newCommunicationState->CommType && !d->CurrentCommunicationState.CommType){\
  61                 MSG_WAR(0x9999,#FuncStart, 9999);\
  62                 d->CurrentCommunicationState.CommType = 1;\
  63                 FuncStart;\
  64         }else if(!newCommunicationState->CommType && d->CurrentCommunicationState.CommType){\
  65                 MSG_WAR(0x9999,#FuncStop, 9999);\
  66                 d->CurrentCommunicationState.CommType = 0;\
  67                 FuncStop;\
  68         }
  69 \end{verbatim}\end{Code}
  70
  71
  72 Definition at line 76 of file states.c.
  73
  74 \subsection{Function Documentation}
  75 \hypertarget{states_8c_1ee4d5c3d5dc6f39607d414b7bf9bcc9}{
  76 \index{states.c@{states.c}!_initialisation@{\_\-initialisation}}
  77 \index{_initialisation@{\_\-initialisation}!states.c@{states.c}}
  78 \subsubsection[\_\-initialisation]{\setlength{\rightskip}{0pt plus 5cm}void \_\-initialisation ()}}
  79 \label{states_8c_1ee4d5c3d5dc6f39607d414b7bf9bcc9}
  80
  81
  82
  83
  84 Definition at line 234 of file states.c.\hypertarget{states_8c_4c917142acca702f7e04e919a0b958b4}{
  85 \index{states.c@{states.c}!_operational@{\_\-operational}}
  86 \index{_operational@{\_\-operational}!states.c@{states.c}}
  87 \subsubsection[\_\-operational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-operational ()}}
  88 \label{states_8c_4c917142acca702f7e04e919a0b958b4}
  89
  90
  91
  92
  93 Definition at line 236 of file states.c.\hypertarget{states_8c_00113c22ed3366ee552f77862241d317}{
  94 \index{states.c@{states.c}!_preOperational@{\_\-preOperational}}
  95 \index{_preOperational@{\_\-preOperational}!states.c@{states.c}}
  96 \subsubsection[\_\-preOperational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-pre\-Operational ()}}
  97 \label{states_8c_00113c22ed3366ee552f77862241d317}
  98
  99
 100
 101
 102 Definition at line 235 of file states.c.\hypertarget{states_8c_244e9269c323e14509bea947c2729a13}{
 103 \index{states.c@{states.c}!_stopped@{\_\-stopped}}
 104 \index{_stopped@{\_\-stopped}!states.c@{states.c}}
 105 \subsubsection[\_\-stopped]{\setlength{\rightskip}{0pt plus 5cm}void \_\-stopped ()}}
 106 \label{states_8c_244e9269c323e14509bea947c2729a13}
 107
 108
 109
 110
 111 Definition at line 237 of file states.c.\hypertarget{states_8c_3f8975650604cc23582f19a43fd4e518}{
 112 \index{states.c@{states.c}!canDispatch@{canDispatch}}
 113 \index{canDispatch@{canDispatch}!states.c@{states.c}}
 114 \subsubsection[canDispatch]{\setlength{\rightskip}{0pt plus 5cm}void can\-Dispatch (CO\_\-Data $\ast$ {\em d}, Message $\ast$ {\em m})}}
 115 \label{states_8c_3f8975650604cc23582f19a43fd4e518}
 116
 117
 118
 119
 120 Definition at line 39 of file states.c.
 121
 122 References proceed\-NMTstate\-Change(), proceed\-NODE\_\-GUARD(), proceed\-PDO(), proceed\-SDO(), and proceed\-SYNC().\hypertarget{states_8c_3020f2e5762f6e389a21382ec827b6a6}{
 123 \index{states.c@{states.c}!getNodeId@{getNodeId}}
 124 \index{getNodeId@{getNodeId}!states.c@{states.c}}
 125 \subsubsection[getNodeId]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-Node\-Id (CO\_\-Data $\ast$ {\em d})}}
 126 \label{states_8c_3020f2e5762f6e389a21382ec827b6a6}
 127
 128
 129
 130
 131 Definition at line 180 of file states.c.\hypertarget{states_8c_95d835785ba564bf6d92e3224c5e3848}{
 132 \index{states.c@{states.c}!getState@{getState}}
 133 \index{getState@{getState}!states.c@{states.c}}
 134 \subsubsection[getState]{\setlength{\rightskip}{0pt plus 5cm}e\_\-node\-State get\-State (CO\_\-Data $\ast$ {\em d})}}
 135 \label{states_8c_95d835785ba564bf6d92e3224c5e3848}
 136
 137
 138
 139
 140 Definition at line 33 of file states.c.\hypertarget{states_8c_d47a53979b9311a374d029f7923abbe1}{
 141 \index{states.c@{states.c}!setNodeId@{setNodeId}}
 142 \index{setNodeId@{setNodeId}!states.c@{states.c}}
 143 \subsubsection[setNodeId]{\setlength{\rightskip}{0pt plus 5cm}void set\-Node\-Id (CO\_\-Data $\ast$ {\em d}, UNS8 {\em node\-Id})}}
 144 \label{states_8c_d47a53979b9311a374d029f7923abbe1}
 145
 146
 147
 148
 149 Definition at line 186 of file states.c.\hypertarget{states_8c_0a5004efd1dedbee82a4f21ec5c44fb5}{
 150 \index{states.c@{states.c}!setState@{setState}}
 151 \index{setState@{setState}!states.c@{states.c}}
 152 \subsubsection[setState]{\setlength{\rightskip}{0pt plus 5cm}UNS8 set\-State (CO\_\-Data $\ast$ {\em d}, e\_\-node\-State {\em new\-State})}}
 153 \label{states_8c_0a5004efd1dedbee82a4f21ec5c44fb5}
 154
 155
 156
 157
 158 Definition at line 100 of file states.c.
 159
 160 References decompo\_\-dcf(), ptr\-Table, and switch\-Communication\-State().\hypertarget{states_8c_915991eebf7c2ac6c929c6c9cfbd7d03}{
 161 \index{states.c@{states.c}!switchCommunicationState@{switchCommunicationState}}
 162 \index{switchCommunicationState@{switchCommunicationState}!states.c@{states.c}}
 163 \subsubsection[switchCommunicationState]{\setlength{\rightskip}{0pt plus 5cm}void switch\-Communication\-State (CO\_\-Data $\ast$ {\em d}, s\_\-state\_\-communication $\ast$ {\em new\-Communication\-State})}}
 164 \label{states_8c_915991eebf7c2ac6c929c6c9cfbd7d03}
 165
 166
 167
 168
 169 Definition at line 89 of file states.c.
 170
 171 References heartbeat\-Init(), heartbeat\-Stop(), None, reset\-SDO(), slave\-Send\-Boot\-Up(), Start\-Or\-Stop, start\-SYNC(), and stop\-SYNC().