|
1 \hypertarget{classcan__uvccm__win32}{ |
|
2 \section{can\_\-uvccm\_\-win32 Class Reference} |
|
3 \label{classcan__uvccm__win32}\index{can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
4 } |
|
5 \subsection*{Public Member Functions} |
|
6 \begin{CompactItemize} |
|
7 \item |
|
8 \hyperlink{classcan__uvccm__win32_f4f6d1f25174fd3b7d897a5f73bc363e}{can\_\-uvccm\_\-win32} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board) |
|
9 \item |
|
10 \hyperlink{classcan__uvccm__win32_39bb5c7bb141391d0f2f34b7dd5f487c}{$\sim$can\_\-uvccm\_\-win32} () |
|
11 \item |
|
12 bool \hyperlink{classcan__uvccm__win32_3358bfa32c0164bc11d220745e3e0430}{send} (const \hyperlink{structMessage}{Message} $\ast$m) |
|
13 \item |
|
14 bool \hyperlink{classcan__uvccm__win32_4301393c1d3046b35d0b545e761b94db}{receive} (\hyperlink{structMessage}{Message} $\ast$m) |
|
15 \end{CompactItemize} |
|
16 \subsection*{Private Member Functions} |
|
17 \begin{CompactItemize} |
|
18 \item |
|
19 bool \hyperlink{classcan__uvccm__win32_7fb6732edc691451bc1d3206c07d4715}{open\_\-rs232} (int port=1, int baud\_\-rate=57600) |
|
20 \item |
|
21 bool \hyperlink{classcan__uvccm__win32_06f9d2fb860a821436471c3233f91dff}{close\_\-rs232} () |
|
22 \item |
|
23 bool \hyperlink{classcan__uvccm__win32_c3d1d02a46518b2639beb6060f79f2a2}{get\_\-can\_\-data} (const char $\ast$can\_\-cmd\_\-buf, long \&bufsize, \hyperlink{structMessage}{Message} $\ast$m) |
|
24 \item |
|
25 bool \hyperlink{classcan__uvccm__win32_0f2aed9c45f29e6082f37ea17aea46ae}{set\_\-can\_\-data} (const \hyperlink{structMessage}{Message} \&m, std::string \&can\_\-cmd) |
|
26 \end{CompactItemize} |
|
27 \subsection*{Private Attributes} |
|
28 \begin{CompactItemize} |
|
29 \item |
|
30 HANDLE \hyperlink{classcan__uvccm__win32_3f13c1748b3cd57fd1d478782428859a}{m\_\-port} |
|
31 \item |
|
32 HANDLE \hyperlink{classcan__uvccm__win32_cf25e6725871137696ab41b06fa05417}{m\_\-read\_\-event} |
|
33 \item |
|
34 HANDLE \hyperlink{classcan__uvccm__win32_544ea7fd0e8a5d7cfb7cf9058d6020a4}{m\_\-write\_\-event} |
|
35 \item |
|
36 std::string \hyperlink{classcan__uvccm__win32_d264855657adc02fbc687f37d302fc9f}{m\_\-residual\_\-buffer} |
|
37 \end{CompactItemize} |
|
38 \subsection*{Data Structures} |
|
39 \begin{CompactItemize} |
|
40 \item |
|
41 class \hyperlink{classcan__uvccm__win32_1_1error}{error} |
|
42 \end{CompactItemize} |
|
43 |
|
44 |
|
45 \subsection{Detailed Description} |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 Definition at line 17 of file can\_\-uvccm\_\-win32.cpp. |
|
51 |
|
52 \subsection{Constructor \& Destructor Documentation} |
|
53 \hypertarget{classcan__uvccm__win32_f4f6d1f25174fd3b7d897a5f73bc363e}{ |
|
54 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
55 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
56 \subsubsection[can\_\-uvccm\_\-win32]{\setlength{\rightskip}{0pt plus 5cm}can\_\-uvccm\_\-win32::can\_\-uvccm\_\-win32 (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board})}} |
|
57 \label{classcan__uvccm__win32_f4f6d1f25174fd3b7d897a5f73bc363e} |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 Definition at line 39 of file can\_\-uvccm\_\-win32.cpp. |
|
63 |
|
64 References struct\_\-s\_\-BOARD::baudrate, and open\_\-rs232().\hypertarget{classcan__uvccm__win32_39bb5c7bb141391d0f2f34b7dd5f487c}{ |
|
65 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!~can_uvccm_win32@{$\sim$can\_\-uvccm\_\-win32}} |
|
66 \index{~can_uvccm_win32@{$\sim$can\_\-uvccm\_\-win32}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
67 \subsubsection[$\sim$can\_\-uvccm\_\-win32]{\setlength{\rightskip}{0pt plus 5cm}can\_\-uvccm\_\-win32::$\sim$can\_\-uvccm\_\-win32 ()}} |
|
68 \label{classcan__uvccm__win32_39bb5c7bb141391d0f2f34b7dd5f487c} |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 Definition at line 47 of file can\_\-uvccm\_\-win32.cpp. |
|
74 |
|
75 References close\_\-rs232(). |
|
76 |
|
77 \subsection{Member Function Documentation} |
|
78 \hypertarget{classcan__uvccm__win32_3358bfa32c0164bc11d220745e3e0430}{ |
|
79 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!send@{send}} |
|
80 \index{send@{send}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
81 \subsubsection[send]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::send (const \hyperlink{structMessage}{Message} $\ast$ {\em m})}} |
|
82 \label{classcan__uvccm__win32_3358bfa32c0164bc11d220745e3e0430} |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 Definition at line 52 of file can\_\-uvccm\_\-win32.cpp. |
|
88 |
|
89 References FALSE, m\_\-port, m\_\-write\_\-event, set\_\-can\_\-data(), and eds\_\-utils::Write\-File().\hypertarget{classcan__uvccm__win32_4301393c1d3046b35d0b545e761b94db}{ |
|
90 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!receive@{receive}} |
|
91 \index{receive@{receive}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
92 \subsubsection[receive]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::receive (\hyperlink{structMessage}{Message} $\ast$ {\em m})}} |
|
93 \label{classcan__uvccm__win32_4301393c1d3046b35d0b545e761b94db} |
|
94 |
|
95 |
|
96 |
|
97 |
|
98 Definition at line 80 of file can\_\-uvccm\_\-win32.cpp. |
|
99 |
|
100 References FALSE, get\_\-can\_\-data(), m\_\-port, m\_\-read\_\-event, and m\_\-residual\_\-buffer.\hypertarget{classcan__uvccm__win32_7fb6732edc691451bc1d3206c07d4715}{ |
|
101 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!open_rs232@{open\_\-rs232}} |
|
102 \index{open_rs232@{open\_\-rs232}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
103 \subsubsection[open\_\-rs232]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::open\_\-rs232 (int {\em port} = {\tt 1}, int {\em baud\_\-rate} = {\tt 57600})\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
104 \label{classcan__uvccm__win32_7fb6732edc691451bc1d3206c07d4715} |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 Definition at line 136 of file can\_\-uvccm\_\-win32.cpp. |
|
110 |
|
111 References FALSE, m\_\-port, m\_\-read\_\-event, m\_\-write\_\-event, and TRUE.\hypertarget{classcan__uvccm__win32_06f9d2fb860a821436471c3233f91dff}{ |
|
112 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!close_rs232@{close\_\-rs232}} |
|
113 \index{close_rs232@{close\_\-rs232}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
114 \subsubsection[close\_\-rs232]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::close\_\-rs232 ()\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
115 \label{classcan__uvccm__win32_06f9d2fb860a821436471c3233f91dff} |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 Definition at line 190 of file can\_\-uvccm\_\-win32.cpp. |
|
121 |
|
122 References m\_\-port, m\_\-read\_\-event, m\_\-residual\_\-buffer, and m\_\-write\_\-event.\hypertarget{classcan__uvccm__win32_c3d1d02a46518b2639beb6060f79f2a2}{ |
|
123 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!get_can_data@{get\_\-can\_\-data}} |
|
124 \index{get_can_data@{get\_\-can\_\-data}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
125 \subsubsection[get\_\-can\_\-data]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::get\_\-can\_\-data (const char $\ast$ {\em can\_\-cmd\_\-buf}, long \& {\em bufsize}, \hyperlink{structMessage}{Message} $\ast$ {\em m})\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
126 \label{classcan__uvccm__win32_c3d1d02a46518b2639beb6060f79f2a2} |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 Definition at line 206 of file can\_\-uvccm\_\-win32.cpp. |
|
132 |
|
133 References Message::cob\_\-id, Message::data, Message::len, Message::rtr, UNS8, and SHORT\_\-CAN::w.\hypertarget{classcan__uvccm__win32_0f2aed9c45f29e6082f37ea17aea46ae}{ |
|
134 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!set_can_data@{set\_\-can\_\-data}} |
|
135 \index{set_can_data@{set\_\-can\_\-data}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
136 \subsubsection[set\_\-can\_\-data]{\setlength{\rightskip}{0pt plus 5cm}bool can\_\-uvccm\_\-win32::set\_\-can\_\-data (const \hyperlink{structMessage}{Message} \& {\em m}, std::string \& {\em can\_\-cmd})\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
137 \label{classcan__uvccm__win32_0f2aed9c45f29e6082f37ea17aea46ae} |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 Definition at line 271 of file can\_\-uvccm\_\-win32.cpp. |
|
143 |
|
144 References Message::cob\_\-id, Message::data, Message::len, Message::rtr, and SHORT\_\-CAN::w. |
|
145 |
|
146 \subsection{Field Documentation} |
|
147 \hypertarget{classcan__uvccm__win32_3f13c1748b3cd57fd1d478782428859a}{ |
|
148 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!m_port@{m\_\-port}} |
|
149 \index{m_port@{m\_\-port}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
150 \subsubsection[m\_\-port]{\setlength{\rightskip}{0pt plus 5cm}HANDLE \hyperlink{classcan__uvccm__win32_3f13c1748b3cd57fd1d478782428859a}{can\_\-uvccm\_\-win32::m\_\-port}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
151 \label{classcan__uvccm__win32_3f13c1748b3cd57fd1d478782428859a} |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 Definition at line 33 of file can\_\-uvccm\_\-win32.cpp.\hypertarget{classcan__uvccm__win32_cf25e6725871137696ab41b06fa05417}{ |
|
157 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!m_read_event@{m\_\-read\_\-event}} |
|
158 \index{m_read_event@{m\_\-read\_\-event}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
159 \subsubsection[m\_\-read\_\-event]{\setlength{\rightskip}{0pt plus 5cm}HANDLE \hyperlink{classcan__uvccm__win32_cf25e6725871137696ab41b06fa05417}{can\_\-uvccm\_\-win32::m\_\-read\_\-event}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
160 \label{classcan__uvccm__win32_cf25e6725871137696ab41b06fa05417} |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 Definition at line 34 of file can\_\-uvccm\_\-win32.cpp.\hypertarget{classcan__uvccm__win32_544ea7fd0e8a5d7cfb7cf9058d6020a4}{ |
|
166 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!m_write_event@{m\_\-write\_\-event}} |
|
167 \index{m_write_event@{m\_\-write\_\-event}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
168 \subsubsection[m\_\-write\_\-event]{\setlength{\rightskip}{0pt plus 5cm}HANDLE \hyperlink{classcan__uvccm__win32_544ea7fd0e8a5d7cfb7cf9058d6020a4}{can\_\-uvccm\_\-win32::m\_\-write\_\-event}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
169 \label{classcan__uvccm__win32_544ea7fd0e8a5d7cfb7cf9058d6020a4} |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 Definition at line 35 of file can\_\-uvccm\_\-win32.cpp.\hypertarget{classcan__uvccm__win32_d264855657adc02fbc687f37d302fc9f}{ |
|
175 \index{can_uvccm_win32@{can\_\-uvccm\_\-win32}!m_residual_buffer@{m\_\-residual\_\-buffer}} |
|
176 \index{m_residual_buffer@{m\_\-residual\_\-buffer}!can_uvccm_win32@{can\_\-uvccm\_\-win32}} |
|
177 \subsubsection[m\_\-residual\_\-buffer]{\setlength{\rightskip}{0pt plus 5cm}std::string \hyperlink{classcan__uvccm__win32_d264855657adc02fbc687f37d302fc9f}{can\_\-uvccm\_\-win32::m\_\-residual\_\-buffer}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
|
178 \label{classcan__uvccm__win32_d264855657adc02fbc687f37d302fc9f} |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 Definition at line 36 of file can\_\-uvccm\_\-win32.cpp. |
|
184 |
|
185 The documentation for this class was generated from the following file:\begin{CompactItemize} |
|
186 \item |
|
187 /home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-uvccm\_\-win32/\hyperlink{can__uvccm__win32_8cpp}{can\_\-uvccm\_\-win32.cpp}\end{CompactItemize} |