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