doc/doxygen/latex/states_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{states_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/states.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{states_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/states.h@{/home/epimerde/documents/tc11/CanFestival-3/include/states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\subsection*{Data Structures}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
struct \hyperlink{structs__state__communication}{s\_\-state\_\-communication}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
typedef enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
typedef void($\ast$) \hyperlink{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{initialisation\_\-t} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
typedef void($\ast$) \hyperlink{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{pre\-Operational\_\-t} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
typedef void($\ast$) \hyperlink{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{operational\_\-t} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
typedef void($\ast$) \hyperlink{states_8h_c99397ce6341b6b5128104aee4c27ec5}{stopped\_\-t} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\subsection*{Enumerations}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \{ \par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5}{Initialisation} =  0x00, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443}{Disconnected} =  0x01, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0}{Connecting} =  0x02, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b}{Preparing} =  0x02, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75}{Stopped} =  0x04, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124}{Operational} =  0x05, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7}{Pre\_\-operational} =  0x7F, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59}{Unknown\_\-state} =  0x0F
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
 \}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
void \hyperlink{states_8h_67ca1ac7ff49e88cf7847e408b258cae}{\_\-initialisation} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
void \hyperlink{states_8h_f4e52eb187303eca1962bb6f74cb8169}{\_\-pre\-Operational} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
void \hyperlink{states_8h_b31a0526e24de79a09ccc512db420d91}{\_\-operational} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
void \hyperlink{states_8h_9117ccff20aaed468dd715517e77dbc3}{\_\-stopped} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
void \hyperlink{states_8h_3f8975650604cc23582f19a43fd4e518}{can\-Dispatch} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} \hyperlink{states_8h_95d835785ba564bf6d92e3224c5e3848}{get\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
UNS8 \hyperlink{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5}{set\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} new\-State)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
UNS8 \hyperlink{states_8h_3020f2e5762f6e389a21382ec827b6a6}{get\-Node\-Id} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
void \hyperlink{states_8h_d47a53979b9311a374d029f7923abbe1}{set\-Node\-Id} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
void \hyperlink{states_8h_3e57769f3a958c103825263b7abdd92b}{init\-Pre\-Operational\-Mode} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\hypertarget{states_8h_5891f63a4c9243179838389a93d084e2}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\index{states.h@{states.h}!e_nodeState@{e\_\-nodeState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\index{e_nodeState@{e\_\-nodeState}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\subsubsection[e\_\-nodeState]{\setlength{\rightskip}{0pt plus 5cm}typedef enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
\label{states_8h_5891f63a4c9243179838389a93d084e2}
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 46 of file states.h.\hypertarget{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{states.h@{states.h}!initialisation_t@{initialisation\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\index{initialisation_t@{initialisation\_\-t}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\subsubsection[initialisation\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{initialisation\_\-t}(void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\label{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}
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
Function that user app can overload 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
Definition at line 61 of file states.h.\hypertarget{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
\index{states.h@{states.h}!operational_t@{operational\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\index{operational_t@{operational\_\-t}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\subsubsection[operational\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{operational\_\-t}(void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\label{states_8h_8aed99e590473f26db47a9c2dc5b73fc}
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 63 of file states.h.\hypertarget{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
\index{states.h@{states.h}!preOperational_t@{preOperational\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
\index{preOperational_t@{preOperational\_\-t}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
\subsubsection[preOperational\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{pre\-Operational\_\-t}(void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\label{states_8h_f4a6da4fe018afbe20eaf716c248e02a}
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 62 of file states.h.\hypertarget{states_8h_c99397ce6341b6b5128104aee4c27ec5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
\index{states.h@{states.h}!stopped_t@{stopped\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
\index{stopped_t@{stopped\_\-t}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
\subsubsection[stopped\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_c99397ce6341b6b5128104aee4c27ec5}{stopped\_\-t}(void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
\label{states_8h_c99397ce6341b6b5128104aee4c27ec5}
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 64 of file states.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
\subsection{Enumeration Type Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
\index{states.h@{states.h}!enum_nodeState@{enum\_\-nodeState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
\index{enum_nodeState@{enum\_\-nodeState}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
\subsubsection[enum\_\-nodeState]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
\label{states_8h_3136d2815abe9d284f985e0a7ec68646}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\begin{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\item[Enumerator: ]\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
\begin{description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
\index{Initialisation@{Initialisation}!states.h@{states.h}}\index{states.h@{states.h}!Initialisation@{Initialisation}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
Initialisation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
\label{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
}]\index{Disconnected@{Disconnected}!states.h@{states.h}}\index{states.h@{states.h}!Disconnected@{Disconnected}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
Disconnected}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
\label{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
}]\index{Connecting@{Connecting}!states.h@{states.h}}\index{states.h@{states.h}!Connecting@{Connecting}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134
Connecting}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   135
\label{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   136
}]\index{Preparing@{Preparing}!states.h@{states.h}}\index{states.h@{states.h}!Preparing@{Preparing}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   137
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   138
Preparing}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   139
\label{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   140
}]\index{Stopped@{Stopped}!states.h@{states.h}}\index{states.h@{states.h}!Stopped@{Stopped}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   141
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   142
Stopped}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   143
\label{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   144
}]\index{Operational@{Operational}!states.h@{states.h}}\index{states.h@{states.h}!Operational@{Operational}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   145
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   146
Operational}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   147
\label{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   148
}]\index{Pre_operational@{Pre\_\-operational}!states.h@{states.h}}\index{states.h@{states.h}!Pre_operational@{Pre\_\-operational}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   149
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   150
Pre\_\-operational}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   151
\label{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   152
}]\index{Unknown_state@{Unknown\_\-state}!states.h@{states.h}}\index{states.h@{states.h}!Unknown_state@{Unknown\_\-state}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   153
\hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   154
Unknown\_\-state}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   155
\label{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   156
}]\end{description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   157
\end{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   158
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   159
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   160
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   161
Definition at line 35 of file states.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   162
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   163
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   164
\hypertarget{states_8h_67ca1ac7ff49e88cf7847e408b258cae}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   165
\index{states.h@{states.h}!_initialisation@{\_\-initialisation}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   166
\index{_initialisation@{\_\-initialisation}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   167
\subsubsection[\_\-initialisation]{\setlength{\rightskip}{0pt plus 5cm}void \_\-initialisation (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   168
\label{states_8h_67ca1ac7ff49e88cf7847e408b258cae}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   169
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   170
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   171
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   172
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   173
Definition at line 234 of file states.c.\hypertarget{states_8h_b31a0526e24de79a09ccc512db420d91}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   174
\index{states.h@{states.h}!_operational@{\_\-operational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   175
\index{_operational@{\_\-operational}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   176
\subsubsection[\_\-operational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-operational (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   177
\label{states_8h_b31a0526e24de79a09ccc512db420d91}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   178
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   179
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   180
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   181
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   182
Definition at line 236 of file states.c.\hypertarget{states_8h_f4e52eb187303eca1962bb6f74cb8169}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   183
\index{states.h@{states.h}!_preOperational@{\_\-preOperational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   184
\index{_preOperational@{\_\-preOperational}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   185
\subsubsection[\_\-preOperational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-pre\-Operational (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   186
\label{states_8h_f4e52eb187303eca1962bb6f74cb8169}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   187
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   188
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   189
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   190
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   191
Definition at line 235 of file states.c.\hypertarget{states_8h_9117ccff20aaed468dd715517e77dbc3}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   192
\index{states.h@{states.h}!_stopped@{\_\-stopped}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   193
\index{_stopped@{\_\-stopped}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   194
\subsubsection[\_\-stopped]{\setlength{\rightskip}{0pt plus 5cm}void \_\-stopped (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   195
\label{states_8h_9117ccff20aaed468dd715517e77dbc3}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   196
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   197
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   198
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   199
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   200
Definition at line 237 of file states.c.\hypertarget{states_8h_3f8975650604cc23582f19a43fd4e518}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   201
\index{states.h@{states.h}!canDispatch@{canDispatch}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   202
\index{canDispatch@{canDispatch}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   203
\subsubsection[canDispatch]{\setlength{\rightskip}{0pt plus 5cm}void can\-Dispatch (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   204
\label{states_8h_3f8975650604cc23582f19a43fd4e518}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   205
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   206
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   207
Called by driver/app when receiving messages 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   208
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   209
Definition at line 39 of file states.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   210
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   211
References Message::cob\_\-id, s\_\-state\_\-communication::cs\-Heartbeat, s\_\-state\_\-communication::cs\-PDO, s\_\-state\_\-communication::cs\-SDO, s\_\-state\_\-communication::cs\-SYNC, struct\_\-CO\_\-Data::Current\-Communication\-State, struct\_\-s\_\-timer\_\-entry::d, struct\_\-CO\_\-Data::iam\_\-a\_\-slave, NMT, NODE\_\-GUARD, PDO1rx, PDO1tx, PDO2rx, PDO2tx, PDO3rx, PDO3tx, PDO4rx, PDO4tx, proceed\-NMTstate\-Change(), proceed\-NODE\_\-GUARD(), proceed\-PDO(), proceed\-SDO(), proceed\-SYNC(), SDOrx, SDOtx, SYNC, and SHORT\_\-CAN::w.\hypertarget{states_8h_3020f2e5762f6e389a21382ec827b6a6}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   212
\index{states.h@{states.h}!getNodeId@{getNodeId}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   213
\index{getNodeId@{getNodeId}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   214
\subsubsection[getNodeId]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-Node\-Id (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   215
\label{states_8h_3020f2e5762f6e389a21382ec827b6a6}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   216
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   217
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   218
Returns the nod\-Id 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   219
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   220
Definition at line 180 of file states.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   221
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   222
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{states_8h_95d835785ba564bf6d92e3224c5e3848}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   223
\index{states.h@{states.h}!getState@{getState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   224
\index{getState@{getState}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   225
\subsubsection[getState]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} get\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   226
\label{states_8h_95d835785ba564bf6d92e3224c5e3848}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   227
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   228
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   229
Returns the state of the node 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   230
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   231
Definition at line 33 of file states.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   232
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   233
References struct\_\-s\_\-timer\_\-entry::d, and struct\_\-CO\_\-Data::node\-State.\hypertarget{states_8h_3e57769f3a958c103825263b7abdd92b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   234
\index{states.h@{states.h}!initPreOperationalMode@{initPreOperationalMode}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   235
\index{initPreOperationalMode@{initPreOperationalMode}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   236
\subsubsection[initPreOperationalMode]{\setlength{\rightskip}{0pt plus 5cm}void init\-Pre\-Operational\-Mode (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   237
\label{states_8h_3e57769f3a958c103825263b7abdd92b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   238
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   239
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   240
Some stuff to do when the node enter in pre-operational mode \hypertarget{states_8h_d47a53979b9311a374d029f7923abbe1}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   241
\index{states.h@{states.h}!setNodeId@{setNodeId}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   242
\index{setNodeId@{setNodeId}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   243
\subsubsection[setNodeId]{\setlength{\rightskip}{0pt plus 5cm}void set\-Node\-Id (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   244
\label{states_8h_d47a53979b9311a374d029f7923abbe1}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   245
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   246
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   247
Define the node ID. Initialize the object dictionary 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   248
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   249
Definition at line 186 of file states.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   250
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   251
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-s\_\-timer\_\-entry::d, struct\_\-CO\_\-Data::first\-Index, struct\_\-CO\_\-Data::last\-Index, struct\_\-CO\_\-Data::objdict, s\_\-quick\_\-index::PDO\_\-RCV, s\_\-quick\_\-index::PDO\_\-TRS, td\_\-subindex::p\-Object, td\_\-indextable::p\-Subindex, s\_\-quick\_\-index::SDO\_\-SVR, UNS16, UNS32, and UNS8.\hypertarget{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   252
\index{states.h@{states.h}!setState@{setState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   253
\index{setState@{setState}!states.h@{states.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   254
\subsubsection[setState]{\setlength{\rightskip}{0pt plus 5cm}UNS8 set\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} {\em new\-State})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   255
\label{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   256
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   257
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   258
Change the state of the node 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   259
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   260
Definition at line 100 of file states.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   261
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   262
References struct\_\-s\_\-timer\_\-entry::d, decompo\_\-dcf(), struct\_\-CO\_\-Data::iam\_\-a\_\-slave, struct\_\-CO\_\-Data::initialisation, Initialisation, struct\_\-CO\_\-Data::node\-State, OD\_\-SUCCESSFUL, struct\_\-CO\_\-Data::operational, Operational, Pre\_\-operational, struct\_\-CO\_\-Data::pre\-Operational, ptr\-Table, struct\_\-CO\_\-Data::scan\-Index\-OD, struct\_\-CO\_\-Data::stopped, Stopped, switch\-Communication\-State(), UNS16, and UNS32.