Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoEthernet.h
Go to the documentation of this file.
1 /**
2 * @file GoEthernet.h
3 * @brief Declares the GoEthernet class.
4 *
5 * @internal
6 * Copyright (C) 2016 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_ETHERNET_H
11 #define GO_SDK_ETHERNET_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @class GoEthernet
19 * @extends kObject
20 * @ingroup GoSdk-Ethernet
21 * @brief Represents Ethernet output settings.
22 */
23 typedef kObject GoEthernet;
24
25 /**
26 * Indicates whether the ethernet connection timeout is enabled. If it is
27 * enabled, the configured timeout value will be used.
28 *
29 * @public @memberof GoEthernet
30 * @version Introduced in firmware 4.3.3.124
31 * @param ethernet GoEthernet object.
32 * @return kTRUE if enabled and kFALSE otherwise.
33 * @see GoEthernet_Timeout, GoEthernet_SetTimeout
34 */
35 GoFx(kBool) GoEthernet_TimeoutEnabled(GoEthernet ethernet);
36
37 /**
38 * Enables or disables the ethernet connection timeout.
39 *
40 * @public @memberof GoEthernet
41 * @version Introduced in firmware 4.3.3.124
42 * @param ethernet GoEthernet object.
43 * @param value kTRUE to enable the connection timeout and
44 * kFALSE to disable it.
45 * @return Operation status.
46 */
47 GoFx(kStatus) GoEthernet_EnableTimeout(GoEthernet ethernet, kBool value);
48
49 /**
50 * Returns the connection timeout value in minutes.
51 *
52 * @public @memberof GoEthernet
53 * @version Introduced in firmware 4.3.3.124
54 * @param ethernet GoEthernet object.
55 * @return Connection timeout value in minutes.
56 */
57 GoFx(k64f) GoEthernet_Timeout(GoEthernet ethernet);
58
59 /**
60 * Sets the connection timeout value.
61 *
62 * @public @memberof GoEthernet
63 * @version Introduced in firmware 4.3.3.124
64 * @param ethernet GoEthernet object.
65 * @param value The timeout value (in minutes).
66 * @return Operation status.
67 */
68 GoFx(kStatus) GoEthernet_SetTimeout(GoEthernet ethernet, k64f value);
69
70 /**
71 * Gets the number of source options for the specified output type.
72 *
73 * @public @memberof GoEthernet
74 * @version Introduced in firmware 4.0.10.27
75 * @param ethernet GoEthernet object.
76 * @param type Output source type.
77 * @return Count of source options.
78 */
79 GoFx(kSize) GoEthernet_OptionCount(GoEthernet ethernet, GoOutputSource type);
80
81 /**
82 * Gets the source option at the specified index.
83 *
84 * @public @memberof GoEthernet
85 * @version Introduced in firmware 4.0.10.27
86 * @param ethernet GoEthernet object.
87 * @param type Output source type.
88 * @param index Source option index.
89 * @return Source option.
90 */
91 GoFx(k32u) GoEthernet_OptionAt(GoEthernet ethernet, GoOutputSource type, kSize index);
92
93 /**
94 * Gets the number of sources of the specified output type that are currently selected for transmission.
95 *
96 * @public @memberof GoEthernet
97 * @version Introduced in firmware 4.0.10.27
98 * @param ethernet GoEthernet object.
99 * @param type Output source type.
100 * @return Count of selected sources.
101 */
102 GoFx(kSize) GoEthernet_SourceCount(GoEthernet ethernet, GoOutputSource type);
103
104 /**
105 * Gets the identifier of the selected output at the specified index.
106 *
107 * @public @memberof GoEthernet
108 * @version Introduced in firmware 4.0.10.27
109 * @param ethernet GoEthernet object.
110 * @param type Output source type.
111 * @param index Selected source index.
112 * @return Source identifier.
113 */
114 GoFx(k32u) GoEthernet_SourceAt(GoEthernet ethernet, GoOutputSource type, kSize index);
115
116 /**
117 * Selects the specified source for transmission.
118 *
119 * @public @memberof GoEthernet
120 * @version Introduced in firmware 4.0.10.27
121 * @param ethernet GoEthernet object.
122 * @param type Output source type.
123 * @param sourceId Output source identifier.
124 * @return Operation status.
125 */
126 GoFx(kStatus) GoEthernet_AddSource(GoEthernet ethernet, GoOutputSource type, k32u sourceId);
127
128 /**
129 * Removes (deselects) the source at the specified index.
130 *
131 * @public @memberof GoEthernet
132 * @version Introduced in firmware 4.0.10.27
133 * @param ethernet GoEthernet object.
134 * @param type Output source type.
135 * @param index Index of the source to be removed.
136 * @return Operation status.
137 */
138 GoFx(kStatus) GoEthernet_RemoveSource(GoEthernet ethernet, GoOutputSource type, kSize index);
139
140 /**
141 * Removes (deselects) all selected sources for the specified output type.
142 *
143 * @public @memberof GoEthernet
144 * @version Introduced in firmware 4.0.10.27
145 * @param ethernet GoEthernet object.
146 * @param type Output source type.
147 * @return Operation status.
148 */
149 GoFx(kStatus) GoEthernet_ClearSources(GoEthernet ethernet, GoOutputSource type);
150
151 /**
152 * Removes (deselects) all selected sources for all possible ethernet output types.
153 *
154 * @public @memberof GoEthernet
155 * @version Introduced in firmware 4.0.10.27
156 * @param ethernet GoEthernet object.
157 * @return Operation status.
158 */
159 GoFx(kStatus) GoEthernet_ClearAllSources(GoEthernet ethernet);
160
161
162 /**
163 * Gets the number of composite source options for the specified output type.
164 *
165 * @public @memberof GoEthernet
166 * @version Introduced in firmware 4.4.4.14
167
168 * @param ethernet GoEthernet object.
169 * @param type Output data type.
170 * @return Count of composite source options.
171 */
172 GoFx(kSize) GoEthernet_CompositeOptionCount(GoEthernet ethernet, GoOutputSource type);
173
174 /**
175 * Gets the composite source option at the specified index.
176 *
177 * @public @memberof GoEthernet
178 * @version Introduced in firmware 4.4.4.14
179 * @param ethernet GoEthernet object.
180 * @param type Output source type.
181 * @param index List index.
182 * @return Composite source option.
183 */
184 GoFx(GoOutputCompositeSource) GoEthernet_CompositeOptionAt(GoEthernet ethernet, GoOutputSource type, kSize index);
185
186 /**
187 * Gets the number of composite sources of the specified output type that are currently selected for transmission.
188 *
189 * @public @memberof GoEthernet
190 * @version Introduced in firmware 4.4.4.14
191 * @param ethernet GoEthernet object.
192 * @param type Output CompositeSource type.
193 * @return Count of selected composite data sources.
194 */
195 GoFx(kSize) GoEthernet_CompositeSourceCount(GoEthernet ethernet, GoOutputSource type);
196
197 /**
198 * Gets the identifier of the selected output at the specified index.
199 *
200 * @public @memberof GoEthernet
201 * @version Introduced in firmware 4.4.4.14
202 * @param ethernet GoEthernet object.
203 * @param type Output CompositeSource type.
204 * @param index Selected index.
205 * @return Composite source value.
206 */
207 GoFx(GoOutputCompositeSource) GoEthernet_CompositeSourceAt(GoEthernet ethernet, GoOutputSource type, kSize index);
208
209 /**
210 * Selects the specified composite source for transmission.
211 *
212 * @public @memberof GoEthernet
213 * @version Introduced in firmware 4.4.4.14
214 * @param ethernet GoEthernet object.
215 * @param type Output CompositeSource type.
216 * @param source Composite source identifier.
217 * @return Operation status.
218 */
219 GoFx(kStatus) GoEthernet_AddCompositeSource(GoEthernet ethernet, GoOutputSource type, GoOutputCompositeSource source);
220
221 /**
222 * Removes (deselects) the composite source at the specified index.
223 *
224 * @public @memberof GoEthernet
225 * @version Introduced in firmware 4.4.4.14
226 * @param ethernet GoEthernet object.
227 * @param type Output type.
228 * @param index Index of the composite source to be removed.
229 * @return Operation status.
230 */
231 GoFx(kStatus) GoEthernet_RemoveCompositeSource(GoEthernet ethernet, GoOutputSource type, kSize index);
232
233 /**
234 * Gets the number of event options.
235 *
236 * @public @memberof GoEthernet
237 * @version Introduced in firmware 4.5.3.57
238 * @param ethernet GoEthernet object.
239 * @return Count of event options.
240 */
241 GoFx(kSize) GoEthernet_EventOptionCount(GoEthernet ethernet);
242
243 /**
244 * Gets the event option at the specified index.
245 *
246 * @public @memberof GoEthernet
247 * @version Introduced in firmware 4.5.3.57
248 * @param ethernet GoEthernet object.
249 * @param index Event EventOption index.
250 * @return Event EventOption.
251 */
252 GoFx(GoEventType) GoEthernet_EventOptionAt(GoEthernet ethernet, kSize index);
253
254 /**
255 * Gets the number of events selected for Gocator protocol output.
256 *
257 * @public @memberof GoEthernet
258 * @version Introduced in firmware 4.5.3.57
259 * @param ethernet GoEthernet object.
260 * @return Count of selected Events.
261 */
262 GoFx(kSize) GoEthernet_EventCount(GoEthernet ethernet);
263
264 /**
265 * Gets the output event associated with the specified index.
266 *
267 * @public @memberof GoEthernet
268 * @version Introduced in firmware 4.5.3.57
269 * @param ethernet GoEthernet object.
270 * @param index Selected event index.
271 * @return Event identifier.
272 */
273 GoFx(GoEventType) GoEthernet_EventAt(GoEthernet ethernet, kSize index);
274
275 /**
276 * Selects the specified event for transmission.
277 *
278 * @public @memberof GoEthernet
279 * @version Introduced in firmware 4.5.3.57
280 * @param ethernet GoEthernet object.
281 * @param type The type of event to add/select.
282 * @return Operation status.
283 */
284 GoFx(kStatus) GoEthernet_AddEvent(GoEthernet ethernet, GoEventType type);
285
286 /**
287 * Removes (deselects) the Event at the specified index.
288 *
289 * @public @memberof GoEthernet
290 * @version Introduced in firmware 4.5.3.57
291 * @param ethernet GoEthernet object.
292 * @param index Index of the event to be removed.
293 * @return Operation status.
294 */
295 GoFx(kStatus) GoEthernet_RemoveEvent(GoEthernet ethernet, kSize index);
296
297 /**
298 * Removes (deselects) all selected events.
299 *
300 * @public @memberof GoEthernet
301 * @version Introduced in firmware 4.5.3.57
302 * @param ethernet GoEthernet object.
303 * @return Operation status.
304 */
305 GoFx(kStatus) GoEthernet_ClearEvents(GoEthernet ethernet);
306
307 /**
308 * Gets the protocol that the ethernet utilizes for output.
309 *
310 * @public @memberof GoEthernet
311 * @version Introduced in firmware 4.0.10.27
312 * @param ethernet GoEthernet object.
313 * @return The ethernet protocol.
314 */
315 GoFx(GoEthernetProtocol) GoEthernet_Protocol(GoEthernet ethernet);
316
317 /**
318 * Sets the protocol which will be output via ethernet.
319 *
320 * @public @memberof GoEthernet
321 * @version Introduced in firmware 4.0.10.27
322 * @param ethernet GoEthernet object.
323 * @param protocol The selected ethernet protocol.
324 * @return Operation status.
325 */
326 GoFx(kStatus) GoEthernet_SetProtocol(GoEthernet ethernet, GoEthernetProtocol protocol);
327
328 /**
329 * Gets the ASCII protocol operational mode.
330 *
331 * @public @memberof GoEthernet
332 * @version Introduced in firmware 4.0.10.27
333 * @param ethernet GoEthernet object.
334 * @return Operation mode.
335 */
336 GoFx(GoAsciiOperation) GoEthernet_AsciiOperation(GoEthernet ethernet);
337
338 /**
339 * Sets the ASCII operation mode.
340 *
341 * @public @memberof GoEthernet
342 * @version Introduced in firmware 4.0.10.27
343 * @param ethernet GoEthernet object.
344 * @param mode The selected ASCII operation mode.
345 * @return Operation status.
346 */
347 GoFx(kStatus) GoEthernet_SetAsciiOperation(GoEthernet ethernet, GoAsciiOperation mode);
348
349 /**
350 * Gets the ASCII protocol control channel port number.
351 *
352 * @public @memberof GoEthernet
353 * @version Introduced in firmware 4.0.10.27
354 * @param ethernet GoEthernet object.
355 * @return Control channel port number.
356 */
357 GoFx(k32u) GoEthernet_AsciiControlPort(GoEthernet ethernet);
358
359 /**
360 * Sets the port number of the ASCII control port.
361 *
362 * @public @memberof GoEthernet
363 * @version Introduced in firmware 4.0.10.27
364 * @param ethernet GoEthernet object.
365 * @param port The selected ASCII control port value.
366 * @return Operation status.
367 */
368 GoFx(kStatus) GoEthernet_SetAsciiControlPort(GoEthernet ethernet, k32u port);
369
370 /**
371 * Gets the ASCII protocol health channel port number.
372 *
373 * @public @memberof GoEthernet
374 * @version Introduced in firmware 4.0.10.27
375 * @param ethernet GoEthernet object.
376 * @return Health channel port number.
377 */
378 GoFx(k32u) GoEthernet_AsciiHealthPort(GoEthernet ethernet);
379
380 /**
381 * Sets the port number of the ASCII health port.
382 *
383 * @public @memberof GoEthernet
384 * @version Introduced in firmware 4.0.10.27
385 * @param ethernet GoEthernet object.
386 * @param port The selected ASCII health port value.
387 * @return Operation status.
388 */
389 GoFx(kStatus) GoEthernet_SetAsciiHealthPort(GoEthernet ethernet, k32u port);
390
391 /**
392 * Gets the ASCII protocol data channel port number.
393 *
394 * @public @memberof GoEthernet
395 * @version Introduced in firmware 4.0.10.27
396 * @param ethernet GoEthernet object.
397 * @return Data channel port number.
398 */
399 GoFx(k32u) GoEthernet_AsciiDataPort(GoEthernet ethernet);
400
401 /**
402 * Sets the port number of the ASCII data port.
403 *
404 * @public @memberof GoEthernet
405 * @version Introduced in firmware 4.0.10.27
406 * @param ethernet GoEthernet object.
407 * @param port The selected ASCII data port value.
408 * @return Operation status.
409 */
410 GoFx(kStatus) GoEthernet_SetAsciiDataPort(GoEthernet ethernet, k32u port);
411
412 /**
413 * Gets the ASCII protocol output delimiter string.
414 *
415 * @public @memberof GoEthernet
416 * @version Introduced in firmware 4.0.10.27
417 * @param ethernet GoEthernet object.
418 * @return A pointer to the string representing the ASCII protocol output delimiter.
419 */
420 GoFx(kChar*) GoEthernet_AsciiDelimiter(GoEthernet ethernet);
421
422 /**
423 * Sets the ASCII protocol output delimiter string.
424 *
425 * @public @memberof GoEthernet
426 * @version Introduced in firmware 4.0.10.27
427 * @param ethernet GoEthernet object.
428 * @param string A pointer to the string representing the ASCII protocol output delimiter.
429 * @return Operation status.
430 */
431 GoFx(kStatus) GoEthernet_SetAsciiDelimiter(GoEthernet ethernet, const kChar* string);
432
433 /**
434 * Gets the ASCII protocol output terminator string.
435 *
436 * @public @memberof GoEthernet
437 * @version Introduced in firmware 4.0.10.27
438 * @param ethernet GoEthernet object.
439 * @return A pointer to the terminator representing the ASCII protocol output delimiter.
440 */
441 GoFx(kChar*) GoEthernet_AsciiTerminator(GoEthernet ethernet);
442
443 /**
444 * Sets the ASCII protocol output terminator string.
445 *
446 * @public @memberof GoEthernet
447 * @version Introduced in firmware 4.0.10.27
448 * @param ethernet GoEthernet object.
449 * @param string A pointer to the string representing the ASCII protocol output terminator.
450 * @return Operation status.
451 */
452 GoFx(kStatus) GoEthernet_SetAsciiTerminator(GoEthernet ethernet, const kChar* string);
453
454 /**
455 * Gets the ASCII protocol output invalid value string.
456 *
457 * @public @memberof GoEthernet
458 * @version Introduced in firmware 4.0.10.27
459 * @param ethernet GoEthernet object.
460 * @return A pointer to the string representing the ASCII protocol output invalid value.
461 */
462 GoFx(kChar*) GoEthernet_AsciiInvalidValue(GoEthernet ethernet);
463
464 /**
465 * Sets the ASCII protocol output invalid value string.
466 *
467 * @public @memberof GoEthernet
468 * @version Introduced in firmware 4.0.10.27
469 * @param ethernet GoEthernet object.
470 * @param string A pointer to the string representing the ASCII protocol output invalid value.
471 * @return Operation status.
472 */
473 GoFx(kStatus) GoEthernet_SetAsciiInvalidValue(GoEthernet ethernet, const kChar* string);
474
475 /**
476 * Gets the ASCII protocol output custom data format string.
477 *
478 * @public @memberof GoEthernet
479 * @version Introduced in firmware 4.0.10.27
480 * @param ethernet GoEthernet object.
481 * @return A pointer to the string representing the ASCII protocol output custom data format.
482 */
483 GoFx(kChar*) GoEthernet_AsciiCustomDataFormat(GoEthernet ethernet);
484
485 /**
486 * Sets the ASCII protocol output custom data format string.
487 *
488 * @public @memberof GoEthernet
489 * @version Introduced in firmware 4.0.10.27
490 * @param ethernet GoEthernet object.
491 * @param string A pointer to the string representing the ASCII protocol output custom data format.
492 * @return Operation status.
493 */
494 GoFx(kStatus) GoEthernet_SetAsciiCustomDataFormat(GoEthernet ethernet, const kChar* string);
495
496 /**
497 * Enables or disables the ASCII protocol output custom data format.
498 *
499 * @public @memberof GoEthernet
500 * @version Introduced in firmware 4.0.10.27
501 * @param ethernet GoEthernet object.
502 * @param enabled kTRUE to enable custom data format output. kFALSE to use the default output format.
503 * @return Operation status.
504 */
505 GoFx(kStatus) GoEthernet_EnableAsciiCustomFormat(GoEthernet ethernet, kBool enabled);
506
507 /**
508 * Returns the value of whether the ASCII protocol custom data format is enabled or disabled.
509 *
510 * @public @memberof GoEthernet
511 * @version Introduced in firmware 4.0.10.27
512 * @param ethernet GoEthernet object.
513 * @return kTRUE if the custom data format is enabled. kFALSE otherwise.
514 */
515 GoFx(kBool) GoEthernet_AsciiCustomFormatEnabled(GoEthernet ethernet);
516
517 /**
518 * Sets the current standard format mode.
519 *
520 * @public @memberof GoEthernet
521 * @version Introduced in firmware 4.5.3.57
522 * @param ethernet GoEthernet object.
523 * @param mode The new StandardFormatMode.
524 * @return Operation status.
525 */
526 GoFx(kStatus) GoEthernet_SetAsciiStandardFormat(GoEthernet ethernet, GoAsciiStandardFormatMode mode);
527
528 /**
529 * Gets the current standard format mode.
530 *
531 * @public @memberof GoEthernet
532 * @version Introduced in firmware 4.5.3.57
533 * @param ethernet GoEthernet object.
534 * @return The StandardFormatMode.
535 */
536 GoFx(kBool) GoEthernet_AsciiStandardFormat(GoEthernet ethernet);
537
538 /**
539 * Enables or disables EthernetIP protocol output buffering.
540 *
541 * @public @memberof GoEthernet
542 * @version Introduced in firmware 4.0.10.27
543 * @param ethernet GoEthernet object.
544 * @param enabled kTRUE to enable buffering. kFALSE to disable it.
545 * @return Operation status.
546 */
547 GoFx(kStatus) GoEthernet_SetEIPBufferingEnabled(GoEthernet ethernet, kBool enabled);
548
549 /**
550 * Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled.
551 *
552 * @public @memberof GoEthernet
553 * @version Introduced in firmware 4.0.10.27
554 * @param ethernet GoEthernet object.
555 * @return kTRUE if buffering is enabled. kFALSE otherwise.
556 */
557 GoFx(kBool) GoEthernet_EIPBufferingEnabled(GoEthernet ethernet);
558
559 /**
560 * Sets the EthernetIP protocol endian output type.
561 *
562 * @public @memberof GoEthernet
563 * @version Introduced in firmware 4.1.3.106
564 * @param ethernet GoEthernet object.
565 * @param type The endian output type to set.
566 * @return Operation status.
567 */
568 GoFx(kStatus) GoEthernet_SetEIPEndianOutputType(GoEthernet ethernet, GoEndianType type);
569
570 /**
571 * Returns the value of the EthernetIP protocol endian output type.
572 *
573 * @public @memberof GoEthernet
574 * @version Introduced in firmware 4.1.3.106
575 * @param ethernet GoEthernet object.
576 * @return Endian output type.
577 */
578 GoFx(kBool) GoEthernet_EIPEndianOutputType(GoEthernet ethernet);
579
580 /**
581 * Sets the EthernetIP protocol implicit trigger override.
582 *
583 * @public @memberof GoEthernet
584 * @version Introduced in firmware 4.2.4.7
585 * @param ethernet GoEthernet object.
586 * @param value The implicit trigger override value to set.
587 * @return Operation status.
588 */
589 GoFx(kStatus) GoEthernet_SetEIPImplicitTriggerOverride(GoEthernet ethernet, GoImplicitTriggerOverride value);
590
591 /**
592 * Returns the value of the EthernetIP protocol implicit trigger override.
593 *
594 * @public @memberof GoEthernet
595 * @version Introduced in firmware 4.2.4.7
596 * @param ethernet GoEthernet object.
597 * @return Implicit trigger override value.
598 */
599 GoFx(GoImplicitTriggerOverride) GoEthernet_EIPImplicitTriggerOverride(GoEthernet ethernet);
600
601 /**
602 * Enables or disables Modbus protocol output buffering.
603 *
604 * @public @memberof GoEthernet
605 * @version Introduced in firmware 4.0.10.27
606 * @param ethernet GoEthernet object.
607 * @param enabled kTRUE to enable buffering. kFALSE to disable it.
608 * @return Operation status.
609 */
610 GoFx(kStatus) GoEthernet_SetModbusBufferingEnabled(GoEthernet ethernet, kBool enabled);
611
612 /**
613 * Returns the value of whether Modbus protocol output buffering is enabled or disabled.
614 *
615 * @public @memberof GoEthernet
616 * @version Introduced in firmware 4.0.10.27
617 * @param ethernet GoEthernet object.
618 * @return kTRUE if buffering is enabled. kFALSE otherwise.
619 */
620 GoFx(kBool) GoEthernet_ModbusBufferingEnabled(GoEthernet ethernet);
621
622 kEndHeader()
623 #include <GoSdk/Outputs/GoEthernet.x.h>
624
625 #endif
k32u
GoEthernet::GoEthernet_EventCount
kSize GoEthernet_EventCount(GoEthernet ethernet)
Gets the number of events selected for Gocator protocol output.
GoEthernet::GoEthernet_SetAsciiStandardFormat
kStatus GoEthernet_SetAsciiStandardFormat(GoEthernet ethernet, GoAsciiStandardFormatMode mode)
Sets the current standard format mode.
GoEthernet::GoEthernet_CompositeOptionAt
GoOutputCompositeSource GoEthernet_CompositeOptionAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the composite source option at the specified index.
GoEthernet::GoEthernet_ClearEvents
kStatus GoEthernet_ClearEvents(GoEthernet ethernet)
Removes (deselects) all selected events.
GoEthernet::GoEthernet_EventOptionCount
kSize GoEthernet_EventOptionCount(GoEthernet ethernet)
Gets the number of event options.
GoEthernet::GoEthernet_ClearAllSources
kStatus GoEthernet_ClearAllSources(GoEthernet ethernet)
Removes (deselects) all selected sources for all possible ethernet output types.
GoEthernet::GoEthernet_SetEIPImplicitTriggerOverride
kStatus GoEthernet_SetEIPImplicitTriggerOverride(GoEthernet ethernet, GoImplicitTriggerOverride value)
Sets the EthernetIP protocol implicit trigger override.
GoEthernet::GoEthernet_AsciiCustomDataFormat
kChar * GoEthernet_AsciiCustomDataFormat(GoEthernet ethernet)
Gets the ASCII protocol output custom data format string.
GoEthernet::GoEthernet_ModbusBufferingEnabled
kBool GoEthernet_ModbusBufferingEnabled(GoEthernet ethernet)
Returns the value of whether Modbus protocol output buffering is enabled or disabled.
GoEthernet::GoEthernet_AddCompositeSource
kStatus GoEthernet_AddCompositeSource(GoEthernet ethernet, GoOutputSource type, GoOutputCompositeSource source)
Selects the specified composite source for transmission.
GoEthernet::GoEthernet_RemoveSource
kStatus GoEthernet_RemoveSource(GoEthernet ethernet, GoOutputSource type, kSize index)
Removes (deselects) the source at the specified index.
GoEthernet::GoEthernet_CompositeSourceAt
GoOutputCompositeSource GoEthernet_CompositeSourceAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the identifier of the selected output at the specified index.
GoEthernet::GoEthernet_AsciiDataPort
k32u GoEthernet_AsciiDataPort(GoEthernet ethernet)
Gets the ASCII protocol data channel port number.
kSize
GoEthernet::GoEthernet_AsciiControlPort
k32u GoEthernet_AsciiControlPort(GoEthernet ethernet)
Gets the ASCII protocol control channel port number.
GoEthernet::GoEthernet_SetProtocol
kStatus GoEthernet_SetProtocol(GoEthernet ethernet, GoEthernetProtocol protocol)
Sets the protocol which will be output via ethernet.
GoEthernet::GoEthernet_SetAsciiHealthPort
kStatus GoEthernet_SetAsciiHealthPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII health port.
GoEthernet::GoEthernet_SetAsciiDelimiter
kStatus GoEthernet_SetAsciiDelimiter(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output delimiter string.
GoEthernetProtocol
Represents a ethernet output protocol.
GoEthernet::GoEthernet_TimeoutEnabled
kBool GoEthernet_TimeoutEnabled(GoEthernet ethernet)
Indicates whether the ethernet connection timeout is enabled.
GoEndianType
Represents an endian output type.
kChar
GoEthernet::GoEthernet_EIPImplicitTriggerOverride
GoImplicitTriggerOverride GoEthernet_EIPImplicitTriggerOverride(GoEthernet ethernet)
Returns the value of the EthernetIP protocol implicit trigger override.
GoEthernet::GoEthernet_EventAt
GoEventType GoEthernet_EventAt(GoEthernet ethernet, kSize index)
Gets the output event associated with the specified index.
GoOutputCompositeSource
Represents a composite data source.
Definition: GoSdkDef.h:790
GoEthernet::GoEthernet_AsciiDelimiter
kChar * GoEthernet_AsciiDelimiter(GoEthernet ethernet)
Gets the ASCII protocol output delimiter string.
GoEthernet::GoEthernet_SetAsciiCustomDataFormat
kStatus GoEthernet_SetAsciiCustomDataFormat(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output custom data format string.
GoEthernet::GoEthernet_SetAsciiInvalidValue
kStatus GoEthernet_SetAsciiInvalidValue(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output invalid value string.
GoEthernet::GoEthernet_Timeout
k64f GoEthernet_Timeout(GoEthernet ethernet)
Returns the connection timeout value in minutes.
GoEthernet::GoEthernet_SetAsciiControlPort
kStatus GoEthernet_SetAsciiControlPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII control port.
GoEthernet::GoEthernet_AsciiOperation
GoAsciiOperation GoEthernet_AsciiOperation(GoEthernet ethernet)
Gets the ASCII protocol operational mode.
GoEthernet::GoEthernet_AddSource
kStatus GoEthernet_AddSource(GoEthernet ethernet, GoOutputSource type, k32u sourceId)
Selects the specified source for transmission.
GoSdkDef.h
Essential SDK declarations.
GoEthernet::GoEthernet_EnableTimeout
kStatus GoEthernet_EnableTimeout(GoEthernet ethernet, kBool value)
Enables or disables the ethernet connection timeout.
GoEthernet::GoEthernet_CompositeOptionCount
kSize GoEthernet_CompositeOptionCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of composite source options for the specified output type.
GoEthernet::GoEthernet_AsciiHealthPort
k32u GoEthernet_AsciiHealthPort(GoEthernet ethernet)
Gets the ASCII protocol health channel port number.
GoImplicitTriggerOverride
Represents an EthernetIP implicit messaging trigger override.
GoEthernet::GoEthernet_CompositeSourceCount
kSize GoEthernet_CompositeSourceCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of composite sources of the specified output type that are currently selected for tra...
GoEthernet::GoEthernet_ClearSources
kStatus GoEthernet_ClearSources(GoEthernet ethernet, GoOutputSource type)
Removes (deselects) all selected sources for the specified output type.
GoAsciiStandardFormatMode
Represents an ASCII standard format type.
GoEthernet::GoEthernet_SetTimeout
kStatus GoEthernet_SetTimeout(GoEthernet ethernet, k64f value)
Sets the connection timeout value.
GoOutputSource
Represents output sources.
GoEthernet::GoEthernet_EnableAsciiCustomFormat
kStatus GoEthernet_EnableAsciiCustomFormat(GoEthernet ethernet, kBool enabled)
Enables or disables the ASCII protocol output custom data format.
GoEthernet::GoEthernet_Protocol
GoEthernetProtocol GoEthernet_Protocol(GoEthernet ethernet)
Gets the protocol that the ethernet utilizes for output.
GoEthernet::GoEthernet_EventOptionAt
GoEventType GoEthernet_EventOptionAt(GoEthernet ethernet, kSize index)
Gets the event option at the specified index.
GoAsciiOperation
Represents an ASCII protocol operational type.
GoEthernet::GoEthernet_SetEIPBufferingEnabled
kStatus GoEthernet_SetEIPBufferingEnabled(GoEthernet ethernet, kBool enabled)
Enables or disables EthernetIP protocol output buffering.
GoEthernet::GoEthernet_OptionAt
k32u GoEthernet_OptionAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the source option at the specified index.
GoEthernet::GoEthernet_AddEvent
kStatus GoEthernet_AddEvent(GoEthernet ethernet, GoEventType type)
Selects the specified event for transmission.
GoEthernet::GoEthernet_SetAsciiTerminator
kStatus GoEthernet_SetAsciiTerminator(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output terminator string.
GoEthernet::GoEthernet_RemoveCompositeSource
kStatus GoEthernet_RemoveCompositeSource(GoEthernet ethernet, GoOutputSource type, kSize index)
Removes (deselects) the composite source at the specified index.
GoEthernet::GoEthernet_SetAsciiOperation
kStatus GoEthernet_SetAsciiOperation(GoEthernet ethernet, GoAsciiOperation mode)
Sets the ASCII operation mode.
kObject
kStatus
GoEthernet::GoEthernet_SourceAt
k32u GoEthernet_SourceAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the identifier of the selected output at the specified index.
GoEthernet::GoEthernet_SetModbusBufferingEnabled
kStatus GoEthernet_SetModbusBufferingEnabled(GoEthernet ethernet, kBool enabled)
Enables or disables Modbus protocol output buffering.
GoEventType
Represents the event type represented by an event message.
GoEthernet::GoEthernet_EIPEndianOutputType
kBool GoEthernet_EIPEndianOutputType(GoEthernet ethernet)
Returns the value of the EthernetIP protocol endian output type.
k64f
GoEthernet::GoEthernet_SetEIPEndianOutputType
kStatus GoEthernet_SetEIPEndianOutputType(GoEthernet ethernet, GoEndianType type)
Sets the EthernetIP protocol endian output type.
GoEthernet::GoEthernet_SetAsciiDataPort
kStatus GoEthernet_SetAsciiDataPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII data port.
GoEthernet
Represents Ethernet output settings.
kBool
GoEthernet::GoEthernet_EIPBufferingEnabled
kBool GoEthernet_EIPBufferingEnabled(GoEthernet ethernet)
Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled...
GoEthernet::GoEthernet_RemoveEvent
kStatus GoEthernet_RemoveEvent(GoEthernet ethernet, kSize index)
Removes (deselects) the Event at the specified index.
GoEthernet::GoEthernet_SourceCount
kSize GoEthernet_SourceCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of sources of the specified output type that are currently selected for transmission...
GoEthernet::GoEthernet_OptionCount
kSize GoEthernet_OptionCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of source options for the specified output type.
GoEthernet::GoEthernet_AsciiCustomFormatEnabled
kBool GoEthernet_AsciiCustomFormatEnabled(GoEthernet ethernet)
Returns the value of whether the ASCII protocol custom data format is enabled or disabled.
GoEthernet::GoEthernet_AsciiStandardFormat
kBool GoEthernet_AsciiStandardFormat(GoEthernet ethernet)
Gets the current standard format mode.
GoEthernet::GoEthernet_AsciiTerminator
kChar * GoEthernet_AsciiTerminator(GoEthernet ethernet)
Gets the ASCII protocol output terminator string.
GoEthernet::GoEthernet_AsciiInvalidValue
kChar * GoEthernet_AsciiInvalidValue(GoEthernet ethernet)
Gets the ASCII protocol output invalid value string.