Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSetup.h
Go to the documentation of this file.
1 /**
2 * @file GoSetup.h
3 * @brief Declares the GoSetup 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_SETUP_H
11 #define GO_SDK_SETUP_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoLayout.h>
15 #include <GoSdk/GoAdvanced.h>
16 #include <GoSdk/GoMaterial.h>
17 #include <GoSdk/GoProfileGeneration.h>
18 #include <GoSdk/GoSurfaceGeneration.h>
19 #include <GoSdk/GoPartDetection.h>
20 #include <GoSdk/GoPartMatching.h>
21 #include <GoSdk/GoSections.h>
22 #include <GoSdk/GoTracheid.h>
23
24 kBeginHeader()
25
26 /**
27 * @class GoSetup
28 * @extends kObject
29 * @ingroup GoSdk
30 * @brief Represents a device configuration.
31 */
32 typedef kObject GoSetup;
33
34
35 /**
36 * This API is experimental and may change in a future release
37 * Enables the trigger burst.
38 *
39 * @public @memberof GoSetup
40 * @param setup GoSetup object.
41 * @param enable enable state.
42 * @return Operation status.
43 */
44 GoFx(kStatus) GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable);
45
46 /**
47 * This API is experimental and may change in a future release
48 * Gets the trigger burst enbaled state.
49 *
50 * @public @memberof GoSetup
51 * @param setup GoSetup object.
52 * @return Operation status.
53 */
54 GoFx(kBool) GoSetup_TriggerBurstEnabled(GoSetup setup);
55
56 /**
57 * This API is experimental and may change in a future release
58 * Gets the trigger burst enbaled state.
59 *
60 * @public @memberof GoSetup
61 * @param setup GoSetup object.
62 * @return Operation status.
63 */
64 GoFx(kBool) GoSetup_TriggerBurstEnabledUsed(GoSetup setup);
65
66
67 /**
68 * This API is experimental and may change in a future release
69 * Gets the trigger burst count.
70 *
71 * @public @memberof GoSetup
72 * @param setup GoSetup object.
73 * @return Burst count.
74 */
75 GoFx(k32u) GoSetup_TriggerBurstCount(GoSetup setup);
76
77 /**
78 * This API is experimental and may change in a future release
79 * Sets the trigger burst count.
80 *
81 * @public @memberof GoSetup
82 * @param setup GoSetup object.
83 * @param count Burst count.
84 * @return Operation status.
85 */
86 GoFx(kStatus) GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count);
87
88 /**
89 * This API is experimental and may change in a future release
90 * Gets the trigger burst enbaled state.
91 *
92 * @public @memberof GoSetup
93 * @param setup GoSetup object.
94 * @return Operation status.
95 */
96 GoFx(kBool) GoSetup_TriggerBurstCountUsed(GoSetup setup);
97
98 /**
99 * Gets Multiplex bank used state
100 *
101 * @public @memberof GoSetup
102 * @version Introduced in firmware 4.0.10.27
103 * @param setup GoSetup object.
104 * @param role GoRole role.
105 * @return Operation status.
106 */
107 GoFx(kBool) GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role);
108
109 /**
110 * Gets Multiplex bank used state.
111 *
112 * @public @memberof GoSetup
113 * @version Introduced in firmware 4.0.10.27
114 * @param setup GoSetup object.
115 * @param role GoRole role.
116 * @return Operation status.
117 */
118 GoFx(k32s) GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role);
119
120 /**
121 * Gets layout grid used state.
122 *
123 * @public @memberof GoSetup
124 * @version Introduced in firmware 4.0.10.27
125 * @param setup GoSetup object.
126 * @param role GoRole role.
127 * @return Operation status.
128 */
129 GoFx(kBool) GoSetup_LayoutGridUsed(GoSetup setup, GoRole role);
130
131 /**
132 * Gets layout grid direction.
133 *
134 * @public @memberof GoSetup
135 * @version Introduced in firmware 4.0.10.27
136 * @param setup GoSetup object.
137 * @param role GoRole role.
138 * @return Operation status.
139 */
140 GoFx(k32s) GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role);
141
142 /**
143 * Gets layout grid column index.
144 *
145 * @public @memberof GoSetup
146 * @version Introduced in firmware 4.0.10.27
147 * @param setup GoSetup object.
148 * @param role GoRole role.
149 * @return Layout grid Column.
150 */
151 GoFx(k32s) GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role);
152
153 /**
154 * Gets layout grid row index.
155 *
156 * @public @memberof GoSetup
157 * @version Introduced in firmware 4.0.10.27
158 * @param setup GoSetup object.
159 * @param role GoRole role.
160 * @return Layout grid row.
161 */
162 GoFx(k32s) GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role);
163
164 /**
165 * Enables the temperature saftey of the sensor system.
166 *
167 * @public @memberof GoSetup
168 * @param setup GoSetup object.
169 * @param enable kBool.
170 * @return Operation status.
171 */
172 GoFx(kStatus) GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable);
173
174
175 /**
176 * Sets the scan mode.
177 *
178 * @public @memberof GoSetup
179 * @param setup GoSetup object.
180 * @param mode Operation mode.
181 * @return Operation status.
182 */
183 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
184
185 /**
186 * Gets the scan mode
187 *
188 * @public @memberof GoSetup
189 * @param setup GoSetup object.
190 * @return Operation mode.
191 */
192 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
193
194 /**
195 * Gets the scan mode option at the specified index.
196 *
197 * @public @memberof GoSetup
198 * @version Introduced in firmware 4.0.10.27
199 * @param setup GoSetup object.
200 * @param index The index with which to retrieve a mode option.
201 * @return Operation mode.
202 * @see GoSetup_ScanModeOptionCount
203 */
204 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, kSize index);
205
206 /**
207 * Gets the scan mode option count.
208 *
209 * @public @memberof GoSetup
210 * @version Introduced in firmware 4.0.10.27
211 * @param setup GoSetup object.
212 * @return Scan mode option count.
213 */
214 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
215
216 /// @cond Gocator_2x00
217
218 /**
219 * Gets the user specified Uniform Spacing enabled state.
220 *
221 * @public @memberof GoSetup
222 * @version Introduced in firmware 4.0.10.27
223 * @param setup GoSetup object.
224 * @return kTRUE if enabled and kFALSE otherwise.
225 * @see GoSetup_UniformSpacingAvailable
226 */
227 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
228
229 /**
230 * Sets the user specified Uniform Spacing enabled state.
231 *
232 * @public @memberof GoSetup
233 * @version Introduced in firmware 4.0.10.27
234 * @param setup GoSetup object.
235 * @param enable kTRUE to enable it and kFALSE to disable it.
236 * @return Operation status.
237 * @see GoSetup_UniformSpacingAvailable
238 */
239 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
240
241 /**
242 * Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used at the moment.
243 *
244 * @public @memberof GoSetup
245 * @version Introduced in firmware 4.0.10.27
246 * @param setup GoSetup object.
247 * @return kTRUE if the user specified Uniform Spacing setting is used and kFALSE otherwise.
248 */
249 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
250
251 /**
252 * Gets the Uniform Spacing enabled system value.
253 *
254 * @public @memberof GoSetup
255 * @version Introduced in firmware 4.0.10.27
256 * @param setup GoSetup object.
257 * @return kTRUE if enabled and kFALSE otherwise.
258 * @see GoSetup_UniformSpacingAvailable
259 */
260 GoFx(kBool) GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup);
261
262 /// @endcond
263
264 /**
265 * Sets the state of the external input triggered encoder Z-pulse feature.
266 *
267 * @public @memberof GoSetup
268 * @version Introduced in firmware 4.1.3.106
269 * @param setup GoSetup object.
270 * @param enable kTRUE to enable it and kFALSE to disable it.
271 * @return Operation status.
272 */
273 GoFx(kStatus) GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable);
274
275 /**
276 * Gets the state of the external input triggered encoder Z-pulse feature.
277 *
278 * @public @memberof GoSetup
279 * @version Introduced in firmware 4.1.3.106
280 * @param setup GoSetup object.
281 * @return kTRUE if enabled and kFALSE otherwise.
282 */
283 GoFx(kBool) GoSetup_ExternalInputZPulseEnabled(GoSetup setup);
284
285 /**
286 * Gets the occlusion reduction enabled state.
287 *
288 * @public @memberof GoSetup
289 * @version Introduced in firmware 4.0.10.27
290 * @param setup GoSetup object.
291 * @return kTRUE if enabled and kFALSE otherwise.
292 */
293 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
294
295 /**
296 * Sets the occlusion reduction enabled state.
297 *
298 * @public @memberof GoSetup
299 * @version Introduced in firmware 4.0.10.27
300 * @param setup GoSetup object.
301 * @param enable kTRUE to enable it and kFALSE to disable it.
302 * @return Operation status.
303 */
304 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
305
306 /**
307 * Returns a boolean representing whether the user occlusion reduction configuration is used.
308 *
309 * @public @memberof GoSetup
310 * @version Introduced in firmware 4.3.3.124
311 * @param setup GoSetup object.
312 * @return kTRUE if used, or kFALSE if not used.
313 */
314 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
315
316 /**
317 * Gets the occlusion reduction system value.
318 *
319 * @public @memberof GoSetup
320 * @version Introduced in firmware 4.3.3.124
321 * @param setup GoSetup object.
322 * @return kTRUE if enabled, or kFALSE if not.
323 */
324 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
325
326 /**
327 * Gets the occlusion reduction algorithm.
328 *
329 * @public @memberof GoSetup
330 * @version Introduced in firmware 4.5.3.57
331 * @param setup GoSetup object.
332 * @return The occlusion reduction algorithm.
333 */
334 GoFx(GoOcclusionReductionAlg) GoSetup_OcclusionReductionAlg(GoSetup setup);
335
336 /**
337 * Sets the occlusion reduction algorithm.
338 *
339 * @public @memberof GoSetup
340 * @version Introduced in firmware 4.5.3.57
341 * @param setup GoSetup object.
342 * @param alg The algorithm to use for occlusion reduction.
343 * @return Operation status.
344 */
345 GoFx(kStatus) GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg);
346
347 /**
348 * Returns a boolean representing whether the user occlusion reduction algorithm is used.
349 *
350 * @public @memberof GoSetup
351 * @version Introduced in firmware 4.5.3.57
352 * @param setup GoSetup object.
353 * @return kTRUE if used, or kFALSE if not used.
354 */
355 GoFx(kBool) GoSetup_OcclusionReductionAlgUsed(GoSetup setup);
356
357 //class - trigger
358
359 /**
360 * Sets the system trigger units.
361 * Ignored if GoSetup_TriggerSource is time or encoder
362 *
363 * @public @memberof GoSetup
364 * @version Introduced in firmware 4.0.10.27
365 * @param setup GoSetup object.
366 * @param unit The system trigger unit.
367 * @return Operation status.
368 */
369 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
370
371 /**
372 * Gets the system trigger units.
373 * Ignored if GoSetup_TriggerSource is time or encoder
374 *
375 * @public @memberof GoSetup
376 * @version Introduced in firmware 4.0.10.27
377 * @param setup GoSetup object.
378 * @return The system domain.
379 */
380 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
381
382 /**
383 * Sets the trigger source for profile triggering.
384 *
385 * @public @memberof GoSetup
386 * @version Introduced in firmware 4.0.10.27
387 * @param setup GoSetup object.
388 * @param source Profile trigger source.
389 * @return Operation status.
390 */
391 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
392
393 /**
394 * Gets the trigger source for profile triggering.
395 *
396 * @public @memberof GoSetup
397 * @version Introduced in firmware 4.0.10.27
398 * @param setup GoSetup object.
399 * @return Profile trigger source.
400 */
401 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
402
403 /**
404 * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
405 *
406 * @public @memberof GoSetup
407 * @version Introduced in firmware 4.0.10.27
408 * @param setup GoSetup object.
409 * @param delay Trigger delay (uS or mm).
410 * @return Operation status.
411 */
412 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
413
414 /**
415 * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
416 *
417 * @public @memberof GoSetup
418 * @version Introduced in firmware 4.0.10.27
419 * @param setup GoSetup object.
420 * @return Trigger delay (uS or mm).
421 */
422 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
423
424 /**
425 * Reports the minimum trigger delay, based on current settings.
426 * Depending on GoDomain, units are uS or mm.
427 *
428 * @public @memberof GoSetup
429 * @version Introduced in firmware 4.0.10.27
430 * @param setup GoSetup object.
431 * @return Minimum trigger delay (uS or mm).
432 */
433 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
434
435 /**
436 * Reports the maximum trigger delay, based on current settings.
437 * Depending on GoDomain, units are uS or mm.
438 *
439 * @public @memberof GoSetup
440 * @version Introduced in firmware 4.0.10.27
441 * @param setup GoSetup object.
442 * @return Maximum trigger delay (uS or mm).
443 */
444 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
445
446 /**
447 * Sets the trigger gate feature.
448 *
449 * @public @memberof GoSetup
450 * @version Introduced in firmware 4.0.10.27
451 * @param setup GoSetup object.
452 * @param enable Enables trigger gate operation.
453 * @return Operation status.
454 */
455 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
456
457 /**
458 * Reports whether the trigger gate feature is currently enabled.
459 *
460 * @public @memberof GoSetup
461 * @version Introduced in firmware 4.0.10.27
462 * @param setup GoSetup object.
463 * @return kTRUE if enabled, or kFALSE if disabled.
464 */
465 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
466
467 /**
468 * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
469 *
470 * @public @memberof GoSetup
471 * @version Introduced in firmware 4.0.10.27
472 * @param setup GoSetup object.
473 * @return kTRUE if the user specified setting is used and kFALSE otherwise.
474 */
475 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
476
477 /**
478 * Reports the trigger gate enabled system value.
479 *
480 * @public @memberof GoSetup
481 * @version Introduced in firmware 4.0.10.27
482 * @param setup GoSetup object.
483 * @return kTRUE if enabled, or kFALSE if disabled.
484 */
485 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
486
487 /**
488 * Enables or disables operation at full frame rate (ignoring frame rate setting).
489 *
490 * @public @memberof GoSetup
491 * @version Introduced in firmware 4.0.10.27
492 * @param setup GoSetup object.
493 * @param enable Enables full frame rate operation.
494 * @return Operation status.
495 */
496 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
497
498 /**
499 * Reports whether or not system is configured to operate at full frame rate.
500 *
501 * @public @memberof GoSetup
502 * @version Introduced in firmware 4.0.10.27
503 * @param setup GoSetup object.
504 * @return True if system operates at full frame rate; false otherwise.
505 */
506 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
507
508 /**
509 * Sets the current frame rate for time-based triggering. The maximum frame
510 * rate option must be disabled to use the value set in this function.
511 *
512 * @public @memberof GoSetup
513 * @version Introduced in firmware 4.0.10.27
514 * @param setup GoSetup object.
515 * @param frameRate Frame Rate value (Hz).
516 * @return Operation status.
517 * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
518 */
519 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
520
521 /**
522 * Reports the currently configured frame rate.
523 *
524 * @public @memberof GoSetup
525 * @version Introduced in firmware 4.0.10.27
526 * @param setup GoSetup object.
527 * @return Maximum frame rate (Hz).
528 */
529 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
530
531 /**
532 * Constraint for the minimum valid value of the Frame Rate setting.
533 *
534 * @public @memberof GoSetup
535 * @version Introduced in firmware 4.0.10.27
536 * @param setup GoSetup object.
537 * @return Minimum valid Frame Rate setting (Hz).
538 */
539 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
540
541 /**
542 * Constraint for the maximum valid value of the Frame Rate setting.
543 *
544 * @public @memberof GoSetup
545 * @version Introduced in firmware 4.0.10.27
546 * @param setup GoSetup object.
547 * @return Maximum valid Frame Rate setting (Hz).
548 */
549 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
550
551 /**
552 * Sets the encoder trigger mode.
553 *
554 * @public @memberof GoSetup
555 * @version Introduced in firmware 4.0.10.27
556 * @param setup GoSetup object.
557 * @param mode Encoder trigger mode.
558 * @return Profile trigger source.
559 */
560 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
561
562 /**
563 * Gets the encoder trigger mode.
564 *
565 * @public @memberof GoSetup
566 * @version Introduced in firmware 4.0.10.27
567 * @param setup GoSetup object.
568 * @return Encoder trigger mode.
569 */
570 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
571
572 /**
573 * Sets the current encoder period for encoder-based triggering.
574 *
575 * @public @memberof GoSetup
576 * @version Introduced in firmware 4.0.10.27
577 * @param setup GoSetup object.
578 * @param period Encoder period (mm).
579 * @return Operation status.
580 */
581 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
582
583 /**
584 * Gets the current encoder period for encoder-based triggering.
585 *
586 * @public @memberof GoSetup
587 * @version Introduced in firmware 4.0.10.27
588 * @param setup GoSetup object.
589 * @return Encoder period (mm).
590 */
591 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
592
593 /**
594 * Constraint for the minimum valid value of the Encoder Period setting.
595 *
596 * @public @memberof GoSetup
597 * @version Introduced in firmware 4.0.10.27
598 * @param setup GoSetup object.
599 * @return Minimum valid Encoder Period setting (mm).
600 */
601 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
602
603 /**
604 * Constraint for the maximum valid value of the Encoder Period setting.
605 *
606 * @public @memberof GoSetup
607 * @version Introduced in firmware 4.0.10.27
608 * @param setup GoSetup object.
609 * @return Maximum valid Encoder Period setting (mm).
610 */
611 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
612
613 /**
614 * Enables profile intensity collection.
615 *
616 * @public @memberof GoSetup
617 * @version Introduced in firmware 4.0.10.27
618 * @param setup GoSetup object.
619 * @param enable kTRUE to enable, or kFALSE to disable.
620 * @return Operation status.
621 */
622 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
623
624 /**
625 * Reports whether the profile intensity collection is enabled.
626 *
627 * @public @memberof GoSetup
628 * @version Introduced in firmware 4.0.10.27
629 * @param setup GoSetup object.
630 * @return kTRUE if enabled, or kFALSE if disabled.
631 */
632 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
633
634 /**
635 * Enables flicker reduction mode.
636 *
637 * @public @memberof GoSetup
638 * @version Introduced in firmware 4.6.2.31
639 * @param setup GoSetup object.
640 * @param enable kTRUE to enable, or kFALSE to disable.
641 * @return Operation status.
642 */
643 GoFx(kStatus) GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable);
644
645
646 /**
647 * Reports whether flicker free mode is enabled.
648 *
649 * @public @memberof GoSetup
650 * @version Introduced in firmware 4.6.2.31
651 * @param setup GoSetup object.
652 * @return kTRUE if enabled, or kFALSE if disabled.
653 */
654 GoFx(kBool) GoSetup_FlickerFreeModeEnabled(GoSetup setup);
655
656 /**
657 * Reports whether flicker free mode is available for use on this sensor.
658 *
659 * @public @memberof GoSetup
660 * @version Introduced in firmware 4.6.2.31
661 * @param setup GoSetup object.
662 * @return kTRUE if available, or kFALSE if not.
663 */
664 GoFx(kBool) GoSetup_FlickerFreeModeAvailable(GoSetup setup);
665
666 //class - alignment
667
668 /**
669 * Gets the input trigger enabled state.
670 *
671 * @public @memberof GoSetup
672 * @version Introduced in firmware 4.0.10.27
673 * @param setup GoSetup object.
674 * @return kTRUE if enabled and kFALSE otherwise.
675 */
676 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
677
678 /**
679 * Returns a boolean representing whether the user input trigger configuration is used.
680 *
681 * @public @memberof GoSetup
682 * @version Introduced in firmware 4.3.3.124
683 * @param setup GoSetup object.
684 * @return kTRUE if used, or kFALSE if not used.
685 */
686 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
687
688 /**
689 * Gets the input trigger system value.
690 *
691 * @public @memberof GoSetup
692 * @version Introduced in firmware 4.3.3.124
693 * @param setup GoSetup object.
694 * @return kTRUE if enabled, or kFALSE if not.
695 */
696 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
697
698 /**
699 * Sets the input trigger enabled state.
700 *
701 * @public @memberof GoSetup
702 * @version Introduced in firmware 4.0.10.27
703 * @param setup GoSetup object.
704 * @param enable kTRUE to enable it and kFALSE to disable it.
705 */
706 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
707
708 /**
709 * Indicates whether alignment can be used.
710 *
711 * @public @memberof GoSetup
712 * @version Introduced in firmware 4.5.3.57
713 * @param setup GoSetup object.
714 * @return True if alignment is available for use.
715 */
716 GoFx(kBool) GoSetup_AlignmentUsed(GoSetup setup);
717
718 /**
719 * Sets the type used for alignment.
720 *
721 * @public @memberof GoSetup
722 * @version Introduced in firmware 4.0.10.27
723 * @param setup GoSetup object.
724 * @param type Alignment type (stationary or moving).
725 * @return Operation status.
726 */
727 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
728
729 /**
730 * Gets the type used for alignment calibration.
731 *
732 * @public @memberof GoSetup
733 * @version Introduced in firmware 4.0.10.27
734 * @param setup GoSetup object.
735 * @return Alignment type (stationary or moving).
736 */
737 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
738
739 /**
740 * Gets the alignment type option at the given index.
741 *
742 * @public @memberof GoSetup
743 * @version Introduced in firmware 4.0.10.27
744 * @param setup GoSetup object.
745 * @param index The index with which to retrieve an alignment type option.
746 * @return Alignment type option.
747 * @see GoSetup_AlignmentTypeOptionCount
748 */
749 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
750
751 /**
752 * Gets the alignment type option count.
753 *
754 * @public @memberof GoSetup
755 * @version Introduced in firmware 4.0.10.27
756 * @param setup GoSetup object.
757 * @return Alignment type option count.
758 */
759 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
760
761 /**
762 * Enables encoder calibration after alignment.
763 *
764 * @public @memberof GoSetup
765 * @version Introduced in firmware 4.0.10.27
766 * @param setup GoSetup object.
767 * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
768 * @return Operation status.
769 */
770 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
771
772 /**
773 * Gets the value of the post alignment encoder calibration setting.
774 *
775 * @public @memberof GoSetup
776 * @version Introduced in firmware 4.0.10.27
777 * @param setup GoSetup object.
778 * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
779 */
780 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
781
782 /**
783 * Sets the target type used for stationary alignment calibration.
784 *
785 * @public @memberof GoSetup
786 * @version Introduced in firmware 4.0.10.27
787 * @param setup GoSetup object.
788 * @param target Alignment target type.
789 * @return Operation status.
790 */
791 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
792
793 /**
794 * Gets the target type used for stationary alignment calibration.
795 *
796 * @public @memberof GoSetup
797 * @version Introduced in firmware 4.0.10.27
798 * @param setup GoSetup object.
799 * @return Alignment target type.
800 */
801 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
802
803 /**
804 * Gets the stationary alignment target option count.
805 *
806 * @public @memberof GoSetup
807 * @version Introduced in firmware 4.0.10.27
808 * @param setup GoSetup object.
809 * @return The alignment target count.
810 */
811 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
812
813 /**
814 * Gets the stationary alignment target option at the given index.
815 *
816 * @public @memberof GoSetup
817 * @version Introduced in firmware 4.0.10.27
818 * @param setup GoSetup object.
819 * @param index The index with which to retrieve an alignment target.
820 * @return The alignment target option.
821 * @see GoSetup_AlignmentStationaryTargetOptionCount
822 */
823 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
824
825 /// @cond (Gocator_1x00 || Gocator_2x00)
826
827 /**
828 * Sets the target type used for moving alignment calibration.
829 *
830 * @public @memberof GoSetup
831 * @version Introduced in firmware 4.0.10.27
832 * @param setup GoSetup object.
833 * @param target Alignment target type.
834 * @return Operation status.
835 */
836 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
837
838 /**
839 * Gets the target type used for moving alignment calibration.
840 *
841 * @public @memberof GoSetup
842 * @version Introduced in firmware 4.0.10.27
843 * @param setup GoSetup object.
844 * @return Alignment target type.
845 */
846 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
847
848 /**
849 * Gets the moving alignment target option count.
850 *
851 * @public @memberof GoSetup
852 * @version Introduced in firmware 4.0.10.27
853 * @param setup GoSetup object.
854 * @return The alignment target count.
855 */
856 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
857
858 /**
859 * Gets the moving alignment target option at the given index.
860 *
861 * @public @memberof GoSetup
862 * @version Introduced in firmware 4.0.10.27
863 * @param setup GoSetup object.
864 * @param index The index with which to retrieve an alignment target.
865 * @return The alignment target option.
866 * @see GoSetup_AlignmentMovingTargetOptionCount
867 */
868 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
869
870 /**
871 * Sets the diameter of the disk used for travel calibration.
872 *
873 * @public @memberof GoSetup
874 * @version Introduced in firmware 4.0.10.27
875 * @param setup GoSetup object.
876 * @param diameter Disk diameter (mm).
877 * @return Operation status.
878 */
879 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
880
881 /**
882 * Gets the diameter of the disk used for travel calibration.
883 *
884 * @public @memberof GoSetup
885 * @version Introduced in firmware 4.0.10.27
886 * @param setup GoSetup object.
887 * @return Disk diameter (mm).
888 */
889 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
890
891 /**
892 * Sets the height of the disk used for travel calibration.
893 *
894 * @public @memberof GoSetup
895 * @version Introduced in firmware 4.0.10.27
896 * @param setup GoSetup object.
897 * @param height Disk height (mm).
898 * @return Operation status.
899 */
900 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
901
902 /**
903 * Gets the height of the disk used for travel calibration.
904 *
905 * @public @memberof GoSetup
906 * @version Introduced in firmware 4.0.10.27
907 * @param setup GoSetup object.
908 * @return Disk height (mm).
909 */
910 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
911
912 /// @endcond
913
914
915 /**
916 * Sets the width of the bar used for travel calibration.
917 *
918 * @public @memberof GoSetup
919 * @version Introduced in firmware 4.0.10.27
920 * @param setup GoSetup object.
921 * @param width Bar width (mm).
922 * @return Operation status.
923 */
924 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
925
926 /**
927 * Gets the width of the bar used for travel calibration.
928 *
929 * @public @memberof GoSetup
930 * @version Introduced in firmware 4.0.10.27
931 * @param setup GoSetup object.
932 * @return Bar width (mm).
933 */
934 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
935
936 /**
937 * Sets the height of the bar used for travel calibration.
938 *
939 * @public @memberof GoSetup
940 * @version Introduced in firmware 4.0.10.27
941 * @param setup GoSetup object.
942 * @param height Bar height (mm).
943 * @return Operation status.
944 */
945 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
946
947 /**
948 * Gets the height of the bar used for travel calibration.
949 *
950 * @public @memberof GoSetup
951 * @version Introduced in firmware 4.0.10.27
952 * @param setup GoSetup object.
953 * @return Bar height (mm).
954 */
955 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
956
957 /**
958 * Indicates if the hole count can be modified by the user.
959 *
960 * @public @memberof GoSetup
961 * @version Introduced in firmware 4.6.3.51
962 * @param setup GoSetup object.
963 * @return kTRUE if used. kFALSE if not.
964 */
965 GoFx(kBool) GoSetup_BarHoleCountUsed(GoSetup setup);
966
967 /**
968 * Gets the number of columns currently configured in the n-buddy layout. Is 0, 1 or 2 in single buddy or unbuddied states.
969 *
970 * @public @memberof GoSetup
971 * @version Introduced in firmware 4.6.3.51
972 * @param setup GoSetup object.
973 * @return Number of columns.
974 */
975 GoFx(kSize) GoSetup_BarHoleCountValue(GoSetup setup);
976
977 /**
978 * Sets the number of holes that are defined on the calibration bar.
979 *
980 * @public @memberof GoSetup
981 * @version Introduced in firmware 4.0.10.27
982 * @param setup GoSetup object.
983 * @param count Hole count.
984 * @return Operation status.
985 */
986 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
987
988 /**
989 * Gets the number of holes that are defined on the calibration bar.
990 *
991 * @public @memberof GoSetup
992 * @version Introduced in firmware 4.0.10.27
993 * @param setup GoSetup object.
994 * @return Hole count.
995 */
996 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
997
998 /**
999 * Indicates if the hole distance can be modified by the user.
1000 *
1001 * @public @memberof GoSetup
1002 * @version Introduced in firmware 4.6.3.51
1003 * @param setup GoSetup object.
1004 * @return kTRUE if used. kFALSE if not.
1005 */
1006 GoFx(kBool) GoSetup_BarHoleDistanceUsed(GoSetup setup);
1007
1008 /**
1009 * Sets the distance between holes that are defined on the calibration bar.
1010 *
1011 * @public @memberof GoSetup
1012 * @version Introduced in firmware 4.0.10.27
1013 * @param setup GoSetup object.
1014 * @param distance Hole distance (mm).
1015 * @return Operation status.
1016 */
1017 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
1018
1019 /**
1020 * Gets the distance between holes that are defined on the calibration bar.
1021 *
1022 * @public @memberof GoSetup
1023 * @version Introduced in firmware 4.0.10.27
1024 * @param setup GoSetup object.
1025 * @return Hole distance (mm).
1026 */
1027 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
1028
1029 /**
1030 * Indicates if the hole diameter can be modified by the user.
1031 *
1032 * @public @memberof GoSetup
1033 * @version Introduced in firmware 4.6.3.55
1034 * @param setup GoSetup object.
1035 * @return kTRUE if used. kFALSE if not.
1036 */
1037 GoFx(kBool) GoSetup_BarHoleDiameterUsed(GoSetup setup);
1038
1039 /**
1040 * Sets the diameter of holes that are defined on the calibration bar.
1041 *
1042 * @public @memberof GoSetup
1043 * @version Introduced in firmware 4.0.10.27
1044 * @param setup GoSetup object.
1045 * @param diameter Hole diameter (mm).
1046 * @return Operation status.
1047 */
1048 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
1049
1050 /**
1051 * Gets the diameter of holes that are defined on the calibration bar.
1052 *
1053 * @public @memberof GoSetup
1054 * @version Introduced in firmware 4.0.10.27
1055 * @param setup GoSetup object.
1056 * @return Hole diameter (mm).
1057 */
1058 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
1059
1060 /**
1061 * Sets the height of the plate used for travel calibration.
1062 *
1063 * @public @memberof GoSetup
1064 * @version Introduced in firmware 4.0.10.27
1065 * @param setup GoSetup object.
1066 * @param height Plate height (mm).
1067 * @return Operation status.
1068 */
1069 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
1070
1071 /**
1072 * Gets the height of the plate used for travel calibration.
1073 *
1074 * @public @memberof GoSetup
1075 * @version Introduced in firmware 4.0.10.27
1076 * @param setup GoSetup object.
1077 * @return Plate height (mm).
1078 */
1079 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
1080
1081 /**
1082 * Sets the number of holes that are defined on the calibration plate.
1083 *
1084 * @public @memberof GoSetup
1085 * @version Introduced in firmware 4.0.10.27
1086 * @param setup GoSetup object.
1087 * @param count Hole count.
1088 * @return Operation status.
1089 */
1090 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
1091
1092 /**
1093 * Gets the number of holes that are defined on the calibration plate.
1094 *
1095 * @public @memberof GoSetup
1096 * @version Introduced in firmware 4.0.10.27
1097 * @param setup GoSetup object.
1098 * @return Hole count.
1099 */
1100 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
1101
1102 /**
1103 * Sets the diameter of the reference hole defined on the calibration plate.
1104 *
1105 * @public @memberof GoSetup
1106 * @version Introduced in firmware 4.0.10.27
1107 * @param setup GoSetup object.
1108 * @param diameter Hole diameter (mm).
1109 * @return Operation status.
1110 */
1111 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
1112
1113 /**
1114 * Gets the diameter of the reference hole defined on the calibration plate.
1115 *
1116 * @public @memberof GoSetup
1117 * @version Introduced in firmware 4.0.10.27
1118 * @param setup GoSetup object.
1119 * @return Hole diameter (mm).
1120 */
1121 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
1122
1123 /**
1124 * Sets the diameter of the secondary hole defined on the calibration plate.
1125 *
1126 * @public @memberof GoSetup
1127 * @version Introduced in firmware 4.0.10.27
1128 * @param setup GoSetup object.
1129 * @param diameter Hole diameter (mm).
1130 * @return Operation status.
1131 */
1132 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
1133
1134 /**
1135 * Gets the diameter of the secondary hole defined on the calibration plate.
1136 *
1137 * @public @memberof GoSetup
1138 * @version Introduced in firmware 4.0.10.27
1139 * @param setup GoSetup object.
1140 * @return Hole diameter (mm).
1141 */
1142 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
1143
1144 /// @cond (Gocator_1x00 || Gocator_2x00)
1145
1146 /**
1147 * Indicates whether X smoothing can be used for the current scan mode and device family.
1148 *
1149 * @public @memberof GoSetup
1150 * @version Introduced in firmware 4.5.3.57
1151 * @param setup GoSetup object.
1152 * @return True if x-smoothing is available for use.
1153 */
1154 GoFx(kBool) GoSetup_XSmoothingUsed(GoSetup setup);
1155
1156 /**
1157 * Sets the status of x-direction smoothing.
1158 *
1159 * @public @memberof GoSetup
1160 * @version Introduced in firmware 4.0.10.27
1161 * @param setup GoSetup object.
1162 * @param enabled Enable or disable x-smoothing
1163 * @return Operation status.
1164 */
1165 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
1166
1167 /**
1168 * Gets the status of x-direction smoothing.
1169 *
1170 * @public @memberof GoSetup
1171 * @version Introduced in firmware 4.0.10.27
1172 * @param setup GoSetup object.
1173 * @return True if x-smoothing is enabled.
1174 */
1175 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
1176
1177 /**
1178 * Sets the x-direction smoothing window.
1179 *
1180 * @public @memberof GoSetup
1181 * @version Introduced in firmware 4.0.10.27
1182 * @param setup GoSetup object.
1183 * @param window The x-smoothing window (mm).
1184 * @return Operation status.
1185 */
1186 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
1187
1188 /**
1189 * Gets the x-direction smoothing window.
1190 *
1191 * @public @memberof GoSetup
1192 * @version Introduced in firmware 4.0.10.27
1193 * @param setup GoSetup object.
1194 * @return The x-smoothing window (mm).
1195 */
1196 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
1197
1198 /**
1199 * Gets the x-direction smoothing window minimum.
1200 *
1201 * @public @memberof GoSetup
1202 * @version Introduced in firmware 4.0.10.27
1203 * @param setup GoSetup object.
1204 * @return The x-smoothing window min (mm).
1205 */
1206 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
1207
1208 /**
1209 * Gets the x-direction smoothing window maximum.
1210 *
1211 * @public @memberof GoSetup
1212 * @version Introduced in firmware 4.0.10.27
1213 * @param setup GoSetup object.
1214 * @return The x-smoothing window max (mm).
1215 */
1216 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
1217
1218 /**
1219 * Indicates whether X median can be used for the current scan mode and device family.
1220 *
1221 * @public @memberof GoSetup
1222 * @version Introduced in firmware 4.5.3.57
1223 * @param setup GoSetup object.
1224 * @return True if x-median is available for use.
1225 */
1226 GoFx(kBool) GoSetup_XMedianUsed(GoSetup setup);
1227
1228 /**
1229 * Sets the status of x-direction median.
1230 *
1231 * @public @memberof GoSetup
1232 * @version Introduced in firmware 4.1.3.106
1233 * @param setup GoSetup object.
1234 * @param enabled Enable or disable x-median
1235 * @return Operation status.
1236 */
1237 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1238
1239 /**
1240 * Gets the status of x-direction median.
1241 *
1242 * @public @memberof GoSetup
1243 * @version Introduced in firmware 4.1.3.106
1244 * @param setup GoSetup object.
1245 * @return True if x-median is enabled.
1246 */
1247 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1248
1249 /**
1250 * Sets the x-direction median window.
1251 *
1252 * @public @memberof GoSetup
1253 * @version Introduced in firmware 4.1.3.106
1254 * @param setup GoSetup object.
1255 * @param window The x-median window (mm).
1256 * @return Operation status.
1257 */
1258 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1259
1260 /**
1261 * Gets the x-direction median window.
1262 *
1263 * @public @memberof GoSetup
1264 * @version Introduced in firmware 4.1.3.106
1265 * @param setup GoSetup object.
1266 * @return The x-median window (mm).
1267 */
1268 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1269
1270 /**
1271 * Gets the x-direction median window minimum.
1272 *
1273 * @public @memberof GoSetup
1274 * @version Introduced in firmware 4.1.3.106
1275 * @param setup GoSetup object.
1276 * @return The x-median window min (mm).
1277 */
1278 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1279
1280 /**
1281 * Gets the x-direction median window maximum.
1282 *
1283 * @public @memberof GoSetup
1284 * @version Introduced in firmware 4.1.3.106
1285 * @param setup GoSetup object.
1286 * @return The x-median window max (mm).
1287 */
1288 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1289
1290 /**
1291 * Indicates whether X decimation can be used for the current scan mode and device family.
1292 *
1293 * @public @memberof GoSetup
1294 * @version Introduced in firmware 4.5.3.57
1295 * @param setup GoSetup object.
1296 * @return True if x-decimation is available for use.
1297 */
1298 GoFx(kBool) GoSetup_XDecimationUsed(GoSetup setup);
1299
1300 /**
1301 * Sets the status of x-direction decimation.
1302 *
1303 * @public @memberof GoSetup
1304 * @version Introduced in firmware 4.1.3.106
1305 * @param setup GoSetup object.
1306 * @param enabled Enable or disable x-decimation
1307 * @return Operation status.
1308 */
1309 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1310
1311 /**
1312 * Gets the status of x-direction decimation.
1313 *
1314 * @public @memberof GoSetup
1315 * @version Introduced in firmware 4.1.3.106
1316 * @param setup GoSetup object.
1317 * @return True if x-decimation is enabled.
1318 */
1319 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1320
1321 /**
1322 * Sets the x-direction decimation window.
1323 *
1324 * @public @memberof GoSetup
1325 * @version Introduced in firmware 4.1.3.106
1326 * @param setup GoSetup object.
1327 * @param window The x-decimation window (mm).
1328 * @return Operation status.
1329 */
1330 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1331
1332 /**
1333 * Gets the x-direction decimation window.
1334 *
1335 * @public @memberof GoSetup
1336 * @version Introduced in firmware 4.1.3.106
1337 * @param setup GoSetup object.
1338 * @return The x-decimation window (mm).
1339 */
1340 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1341
1342 /**
1343 * Gets the x-direction decimation window minimum.
1344 *
1345 * @public @memberof GoSetup
1346 * @version Introduced in firmware 4.1.3.106
1347 * @param setup GoSetup object.
1348 * @return The x-decimation window min (mm).
1349 */
1350 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1351
1352 /**
1353 * Gets the x-direction decimation window maximum.
1354 *
1355 * @public @memberof GoSetup
1356 * @version Introduced in firmware 4.1.3.106
1357 * @param setup GoSetup object.
1358 * @return The x-decimation window max (mm).
1359 */
1360 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1361
1362 /**
1363 * Indicates whether X gap filling can be used for the current scan mode and device family.
1364 *
1365 * @public @memberof GoSetup
1366 * @version Introduced in firmware 4.5.3.57
1367 * @param setup GoSetup object.
1368 * @return True if x-gap filling is available for use.
1369 */
1370 GoFx(kBool) GoSetup_XGapFillingUsed(GoSetup setup);
1371
1372 /**
1373 * Sets the status of x-direction gap-filling.
1374 *
1375 * @public @memberof GoSetup
1376 * @version Introduced in firmware 4.0.10.27
1377 * @param setup GoSetup object.
1378 * @param enable Enable or disable x-gap-filling
1379 * @return Operation status.
1380 */
1381 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1382
1383 /**
1384 * Gets the status of x-direction gap-filling.
1385 *
1386 * @public @memberof GoSetup
1387 * @version Introduced in firmware 4.0.10.27
1388 * @param setup GoSetup object.
1389 * @return True if x-gap-filling is enabled.
1390 */
1391 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1392
1393 /**
1394 * Sets the status of x-direction gap-filling.
1395 *
1396 * @public @memberof GoSetup
1397 * @version Introduced in firmware 4.0.10.27
1398 * @param setup GoSetup object.
1399 * @param window Enable or disable x-gap-filling
1400 * @return Operation status.
1401 */
1402 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1403
1404 /**
1405 * Gets the x-direction gap-filling window.
1406 *
1407 * @public @memberof GoSetup
1408 * @version Introduced in firmware 4.0.10.27
1409 * @param setup GoSetup object.
1410 * @return The x-gap-filling window (mm).
1411 */
1412 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1413
1414 /**
1415 * Gets the x-direction gap-filling window minimum.
1416 *
1417 * @public @memberof GoSetup
1418 * @version Introduced in firmware 4.0.10.27
1419 * @param setup GoSetup object.
1420 * @return The x-gap-filling window min (mm).
1421 */
1422 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1423
1424 /**
1425 * Gets the x-direction gap-filling window maximum.
1426 *
1427 * @public @memberof GoSetup
1428 * @version Introduced in firmware 4.0.10.27
1429 * @param setup GoSetup object.
1430 * @return The x-gap-filling window max (mm).
1431 */
1432 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1433
1434 /**
1435 * Indicates whether X slope can be used for the current scan mode and device family.
1436 *
1437 * @public @memberof GoSetup
1438 * @version Introduced in firmware 4.5.3.57
1439 * @param setup GoSetup object.
1440 * @return True if x-slope is available for use.
1441 */
1442 GoFx(kBool) GoSetup_XSlopeUsed(GoSetup setup);
1443
1444 /**
1445 * Sets the status of x-direction slope.
1446 *
1447 * @public @memberof GoSetup
1448 * @version Introduced in firmware 4.5.2.0
1449 * @param setup GoSetup object.
1450 * @param enable Enable or disable x-slope
1451 * @return Operation status.
1452 */
1453 GoFx(kStatus) GoSetup_EnableXSlope(GoSetup setup, kBool enable);
1454
1455 /**
1456 * Gets the status of x-direction slope.
1457 *
1458 * @public @memberof GoSetup
1459 * @version Introduced in firmware 4.5.2.0
1460 * @param setup GoSetup object.
1461 * @return True if x-slope is enabled.
1462 */
1463 GoFx(kBool) GoSetup_XSlopeEnabled(GoSetup setup);
1464
1465 /**
1466 * Sets the status of x-direction slope.
1467 *
1468 * @public @memberof GoSetup
1469 * @version Introduced in firmware 4.5.2.0
1470 * @param setup GoSetup object.
1471 * @param window Enable or disable x-slope
1472 * @return Operation status.
1473 */
1474 GoFx(kStatus) GoSetup_SetXSlopeWindow(GoSetup setup, k64f window);
1475
1476 /**
1477 * Gets the x-direction slope window.
1478 *
1479 * @public @memberof GoSetup
1480 * @version Introduced in firmware 4.5.2.0
1481 * @param setup GoSetup object.
1482 * @return The x-slope window (mm).
1483 */
1484 GoFx(k64f) GoSetup_XSlopeWindow(GoSetup setup);
1485
1486 /**
1487 * Gets the x-direction slope window minimum.
1488 *
1489 * @public @memberof GoSetup
1490 * @version Introduced in firmware 4.5.2.0
1491 * @param setup GoSetup object.
1492 * @return The x-slope window min (mm).
1493 */
1494 GoFx(k64f) GoSetup_XSlopeWindowLimitMin(GoSetup setup);
1495
1496 /**
1497 * Gets the x-direction slope window maximum.
1498 *
1499 * @public @memberof GoSetup
1500 * @version Introduced in firmware 4.5.2.0
1501 * @param setup GoSetup object.
1502 * @return The x-slope window max (mm).
1503 */
1504 GoFx(k64f) GoSetup_XSlopeWindowLimitMax(GoSetup setup);
1505
1506 /**
1507 * Indicates whether Y smoothing can be used for the current scan mode and device family.
1508 *
1509 * @public @memberof GoSetup
1510 * @version Introduced in firmware 4.5.3.57
1511 * @param setup GoSetup object.
1512 * @return True if y-smoothing is available for use.
1513 */
1514 GoFx(kBool) GoSetup_YSmoothingUsed(GoSetup setup);
1515
1516 /**
1517 * Sets the status of y-direction smoothing.
1518 *
1519 * @public @memberof GoSetup
1520 * @version Introduced in firmware 4.0.10.27
1521 * @param setup GoSetup object.
1522 * @param enable Enable or disable y-smoothing
1523 * @return Operation status.
1524 */
1525 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
1526
1527 /**
1528 * Gets the status of y-direction smoothing.
1529 *
1530 * @public @memberof GoSetup
1531 * @version Introduced in firmware 4.0.10.27
1532 * @param setup GoSetup object.
1533 * @return True if y-smoothing is enabled.
1534 */
1535 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
1536
1537 /**
1538 * Sets the y-direction smoothing window.
1539 *
1540 * @public @memberof GoSetup
1541 * @version Introduced in firmware 4.0.10.27
1542 * @param setup GoSetup object.
1543 * @param window The y-smoothing window (mm).
1544 * @return Operation status.
1545 */
1546 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
1547
1548 /**
1549 * Gets the y-direction smoothing window.
1550 *
1551 * @public @memberof GoSetup
1552 * @version Introduced in firmware 4.0.10.27
1553 * @param setup GoSetup object.
1554 * @return The y-smoothing window (mm).
1555 */
1556 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
1557
1558 /**
1559 * Gets the y-direction smoothing window minimum.
1560 *
1561 * @public @memberof GoSetup
1562 * @version Introduced in firmware 4.0.10.27
1563 * @param setup GoSetup object.
1564 * @return The y-smoothing window min (mm).
1565 */
1566 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
1567
1568 /**
1569 * Gets the y-direction smoothing window maximum.
1570 *
1571 * @public @memberof GoSetup
1572 * @version Introduced in firmware 4.0.10.27
1573 * @param setup GoSetup object.
1574 * @return The y-smoothing window max (mm).
1575 */
1576 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
1577
1578 /**
1579 * Indicates whether Y median can be used for the current scan mode and device family.
1580 *
1581 * @public @memberof GoSetup
1582 * @version Introduced in firmware 4.5.3.57
1583 * @param setup GoSetup object.
1584 * @return True if y-median is available for use.
1585 */
1586 GoFx(kBool) GoSetup_YMedianUsed(GoSetup setup);
1587
1588 /**
1589 * Sets the status of y-direction median.
1590 *
1591 * @public @memberof GoSetup
1592 * @version Introduced in firmware 4.1.3.106
1593 * @param setup GoSetup object.
1594 * @param enable Enable or disable y-median
1595 * @return Operation status.
1596 */
1597 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
1598
1599 /**
1600 * Gets the status of y-direction median.
1601 *
1602 * @public @memberof GoSetup
1603 * @version Introduced in firmware 4.1.3.106
1604 * @param setup GoSetup object.
1605 * @return True if y-median is enabled.
1606 */
1607 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
1608
1609 /**
1610 * Sets the y-direction median window.
1611 *
1612 * @public @memberof GoSetup
1613 * @version Introduced in firmware 4.1.3.106
1614 * @param setup GoSetup object.
1615 * @param window The y-median window (mm).
1616 * @return Operation status.
1617 */
1618 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
1619
1620 /**
1621 * Gets the y-direction median window.
1622 *
1623 * @public @memberof GoSetup
1624 * @version Introduced in firmware 4.1.3.106
1625 * @param setup GoSetup object.
1626 * @return The y-median window (mm).
1627 */
1628 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
1629
1630 /**
1631 * Gets the y-direction median window minimum.
1632 *
1633 * @public @memberof GoSetup
1634 * @version Introduced in firmware 4.1.3.106
1635 * @param setup GoSetup object.
1636 * @return The y-median window min (mm).
1637 */
1638 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
1639
1640 /**
1641 * Gets the y-direction median window maximum.
1642 *
1643 * @public @memberof GoSetup
1644 * @version Introduced in firmware 4.1.3.106
1645 * @param setup GoSetup object.
1646 * @return The y-median window max (mm).
1647 */
1648 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
1649
1650 /**
1651 * Indicates whether y decimation can be used for the current scan mode and device family.
1652 *
1653 * @public @memberof GoSetup
1654 * @version Introduced in firmware 4.5.3.57
1655 * @param setup GoSetup object.
1656 * @return True if y-decimation is available for use.
1657 */
1658 GoFx(kBool) GoSetup_YDecimationUsed(GoSetup setup);
1659
1660 /**
1661 * Sets the status of y-direction decimation.
1662 *
1663 * @public @memberof GoSetup
1664 * @version Introduced in firmware 4.1.3.106
1665 * @param setup GoSetup object.
1666 * @param enable Enable or disable y-decimation
1667 * @return Operation status.
1668 */
1669 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
1670
1671 /**
1672 * Gets the status of y-direction decimation.
1673 *
1674 * @public @memberof GoSetup
1675 * @version Introduced in firmware 4.1.3.106
1676 * @param setup GoSetup object.
1677 * @return True if y-decimation is enabled.
1678 */
1679 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
1680
1681 /**
1682 * Sets the y-direction decimation window.
1683 *
1684 * @public @memberof GoSetup
1685 * @version Introduced in firmware 4.1.3.106
1686 * @param setup GoSetup object.
1687 * @param window The y-decimation window (mm).
1688 * @return Operation status.
1689 */
1690 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
1691
1692 /**
1693 * Gets the y-direction decimation window.
1694 *
1695 * @public @memberof GoSetup
1696 * @version Introduced in firmware 4.1.3.106
1697 * @param setup GoSetup object.
1698 * @return The y-decimation window (mm).
1699 */
1700 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
1701
1702 /**
1703 * Gets the y-direction decimation window minimum.
1704 *
1705 * @public @memberof GoSetup
1706 * @version Introduced in firmware 4.1.3.106
1707 * @param setup GoSetup object.
1708 * @return The y-decimation window min (mm).
1709 */
1710 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
1711
1712 /**
1713 * Gets the y-direction decimation window maximum.
1714 *
1715 * @public @memberof GoSetup
1716 * @version Introduced in firmware 4.1.3.106
1717 * @param setup GoSetup object.
1718 * @return The y-decimation window max (mm).
1719 */
1720 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
1721
1722 /**
1723 * Indicates whether Y slope can be used for the current scan mode and device family.
1724 *
1725 * @public @memberof GoSetup
1726 * @version Introduced in firmware 4.5.3.57
1727 * @param setup GoSetup object.
1728 * @return True if y-slope is available for use.
1729 */
1730 GoFx(kBool) GoSetup_YSlopeUsed(GoSetup setup);
1731
1732 /**
1733 * Sets the status of y-direction slope.
1734 *
1735 * @public @memberof GoSetup
1736 * @version Introduced in firmware 4.5.2.0
1737 * @param setup GoSetup object.
1738 * @param enable Enable or disable y-slope
1739 * @return Operation status.
1740 */
1741 GoFx(kStatus) GoSetup_EnableYSlope(GoSetup setup, kBool enable);
1742
1743 /**
1744 * Gets the status of y-direction slope.
1745 *
1746 * @public @memberof GoSetup
1747 * @version Introduced in firmware 4.5.2.0
1748 * @param setup GoSetup object.
1749 * @return True if y-slope is enabled.
1750 */
1751 GoFx(kBool) GoSetup_YSlopeEnabled(GoSetup setup);
1752
1753 /**
1754 * Sets the status of y-direction slope.
1755 *
1756 * @public @memberof GoSetup
1757 * @version Introduced in firmware 4.5.2.0
1758 * @param setup GoSetup object.
1759 * @param window Enable or disable y-slope
1760 * @return Operation status.
1761 */
1762 GoFx(kStatus) GoSetup_SetYSlopeWindow(GoSetup setup, k64f window);
1763
1764 /**
1765 * Gets the y-direction slope window.
1766 *
1767 * @public @memberof GoSetup
1768 * @version Introduced in firmware 4.5.2.0
1769 * @param setup GoSetup object.
1770 * @return The y-slope window (mm).
1771 */
1772 GoFx(k64f) GoSetup_YSlopeWindow(GoSetup setup);
1773
1774 /**
1775 * Gets the y-direction slope window minimum.
1776 *
1777 * @public @memberof GoSetup
1778 * @version Introduced in firmware 4.5.2.0
1779 * @param setup GoSetup object.
1780 * @return The y-slope window min (mm).
1781 */
1782 GoFx(k64f) GoSetup_YSlopeWindowLimitMin(GoSetup setup);
1783
1784 /**
1785 * Gets the y-direction slope window maximum.
1786 *
1787 * @public @memberof GoSetup
1788 * @version Introduced in firmware 4.5.2.0
1789 * @param setup GoSetup object.
1790 * @return The y-slope window max (mm).
1791 */
1792 GoFx(k64f) GoSetup_YSlopeWindowLimitMax(GoSetup setup);
1793
1794 /// @endcond
1795
1796 /// @cond (Gocator_2x00)
1797
1798 /**
1799 * Indicates whether Y gap filling can be used for the current scan mode and device family.
1800 *
1801 * @public @memberof GoSetup
1802 * @version Introduced in firmware 4.5.3.57
1803 * @param setup GoSetup object.
1804 * @return True if y-gap filling is available for use.
1805 */
1806 GoFx(kBool) GoSetup_YGapFillingUsed(GoSetup setup);
1807
1808 /**
1809 * Sets the status of y-direction gap-filling.
1810 *
1811 * @public @memberof GoSetup
1812 * @version Introduced in firmware 4.0.10.27
1813 * @param setup GoSetup object.
1814 * @param enable Enable or disable y-gap-filling
1815 * @return Operation status.
1816 */
1817 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
1818
1819 /**
1820 * Gets the status of y-direction gap-filling.
1821 *
1822 * @public @memberof GoSetup
1823 * @version Introduced in firmware 4.0.10.27
1824 * @param setup GoSetup object.
1825 * @return True if y-gap-filling is enabled.
1826 */
1827 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
1828
1829 /**
1830 * Sets the y-direction gap-filling window.
1831 *
1832 * @public @memberof GoSetup
1833 * @version Introduced in firmware 4.0.10.27
1834 * @param setup GoSetup object.
1835 * @param window The y-gap-filling window (mm).
1836 * @return
1837 */
1838 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
1839
1840 /**
1841 * Gets the y-direction gap-filling window.
1842 *
1843 * @public @memberof GoSetup
1844 * @version Introduced in firmware 4.0.10.27
1845 * @param setup GoSetup object.
1846 * @return The y-gap-filling window (mm).
1847 */
1848 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
1849
1850 /**
1851 * Gets the y-direction gap-filling window minimum.
1852 *
1853 * @public @memberof GoSetup
1854 * @version Introduced in firmware 4.0.10.27
1855 * @param setup GoSetup object.
1856 * @return The y-gap-filling window min (mm).
1857 */
1858 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
1859
1860 /**
1861 * Gets the y-direction gap-filling window maximum.
1862 *
1863 * @public @memberof GoSetup
1864 * @version Introduced in firmware 4.0.10.27
1865 * @param setup GoSetup object.
1866 * @return The y-gap-filling window max (mm).
1867 */
1868 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
1869
1870 /// @endcond
1871
1872 /**
1873 * Gets the maximum valid value for the Exposure setting.
1874 *
1875 * @public @memberof GoSetup
1876 * @version Introduced in firmware 4.0.10.27
1877 * @param setup GoSetup object.
1878 * @param role Determines which device to retrieve the value from.
1879 * @return Maximum valid Exposure value (microseconds).
1880 */
1881 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
1882
1883 /**
1884 * Gets the minimum valid value for the Exposure setting.
1885 *
1886 * @public @memberof GoSetup
1887 * @version Introduced in firmware 4.0.10.27
1888 * @param setup GoSetup object.
1889 * @param role Determines which device to retrieve the value from.
1890 * @return Minimum valid Exposure value (microseconds).
1891 */
1892 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
1893
1894 /**
1895 * Sets the exposure value.
1896 *
1897 * @public @memberof GoSetup
1898 * @version Introduced in firmware 4.0.10.27
1899 * @param setup GoSetup object.
1900 * @param role Determines which sensor to apply changes to.
1901 * @param exposure Intended exposure value.
1902 * @return Operation status.
1903 */
1904 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
1905
1906 /**
1907 * Gets the exposure value.
1908 *
1909 * @public @memberof GoSetup
1910 * @version Introduced in firmware 4.0.10.27
1911 * @param setup GoSetup object.
1912 * @param role Determines which device to retrieve the value from.
1913 * @return Exposure value (microseconds).
1914 */
1915 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
1916
1917 /**
1918 * Gets the exposure mode.
1919 *
1920 * @public @memberof GoSetup
1921 * @version Introduced in firmware 4.0.10.27
1922 * @param setup GoSetup object.
1923 * @param role Determines which device to retrieve the value from.
1924 * @return Exposure mode.
1925 */
1926 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
1927
1928 /**
1929 * Sets the exposure mode.
1930 *
1931 * @public @memberof GoSetup
1932 * @version Introduced in firmware 4.0.10.27
1933 * @param setup GoSetup object.
1934 * @param role Determines which sensor to apply changes to.
1935 * @param mode The exposure mode to use.
1936 * @return Operation status.
1937 */
1938 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
1939
1940 /**
1941 * Gets the exposure mode option at the given index.
1942 *
1943 * @public @memberof GoSetup
1944 * @version Introduced in firmware 4.0.10.27
1945 * @param setup GoSetup object.
1946 * @param role Determines which device to retrieve the value from.
1947 * @param index The index with which to retrieve an exposure mode option.
1948 * @return Exposure mode option.
1949 * @see GoSetup_ExposureModeOptionCount
1950 */
1951 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
1952
1953 /**
1954 * Gets the exposure mode option count.
1955 *
1956 * @public @memberof GoSetup
1957 * @version Introduced in firmware 4.0.10.27
1958 * @param setup GoSetup object.
1959 * @param role Determines which device to retrieve the value from.
1960 * @return Exposure mode option count.
1961 */
1962 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
1963
1964 /**
1965 * Adds an exposure step
1966 *
1967 * @public @memberof GoSetup
1968 * @version Introduced in firmware 4.0.10.27
1969 * @param setup GoSetup object.
1970 * @param role Determines which sensor to apply changes to.
1971 * @param exposure Exposure value (microseconds).
1972 * @return Operation status.
1973 */
1974 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
1975
1976 /**
1977 * Removes all exposure steps.
1978 *
1979 * @public @memberof GoSetup
1980 * @version Introduced in firmware 4.0.10.27
1981 * @param setup GoSetup object.
1982 * @param role Determines which sensor to apply changes to.
1983 * @return Operation status.
1984 */
1985 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
1986
1987 /**
1988 * Get the exposure step value specified by index
1989 *
1990 * @public @memberof GoSetup
1991 * @version Introduced in firmware 4.0.10.27
1992 * @param setup GoSetup object.
1993 * @param role Determines which device to retrieve the value from.
1994 * @param index The index of the exposure step to get.
1995 * @return The exposure step value (microseconds).
1996 * @see GoSetup_ExposureStepCount
1997 */
1998 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
1999
2000 /**
2001 * Get the number of exposure steps defined
2002 *
2003 * @public @memberof GoSetup
2004 * @version Introduced in firmware 4.0.10.27
2005 * @param setup GoSetup object.
2006 * @param role Determines which device to retrieve the value from.
2007 * @return The count of exposure steps.
2008 */
2009 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
2010
2011 /**
2012 * Gets the maximum value for the Dynamic Exposure setting.
2013 *
2014 * @public @memberof GoSetup
2015 * @version Introduced in firmware 4.0.10.27
2016 * @param setup GoSetup object.
2017 * @param role Determines which device to retrieve the value from.
2018 * @return Maximum Dynamic Exposure value (microseconds).
2019 */
2020 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
2021
2022 /**
2023 * Sets the maximum value for the Dynamic Exposure setting.
2024 *
2025 * @public @memberof GoSetup
2026 * @version Introduced in firmware 4.0.10.27
2027 * @param setup GoSetup object.
2028 * @param role Determines which sensor to apply changes to.
2029 * @param exposure Maximum Dynamic Exposure value (microseconds).
2030 * @return Operation status.
2031 */
2032 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
2033
2034 /**
2035 * Gets the minimum value for the Dynamic Exposure setting.
2036 *
2037 * @public @memberof GoSetup
2038 * @version Introduced in firmware 4.0.10.27
2039 * @param setup GoSetup object.
2040 * @param role Determines which device to retrieve the value from.
2041 * @return Minimum Dynamic Exposure value (microseconds).
2042 */
2043 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
2044
2045 /**
2046 * Sets the minimum value for the Dynamic Exposure setting.
2047 *
2048 * @public @memberof GoSetup
2049 * @version Introduced in firmware 4.0.10.27
2050 * @param setup GoSetup object.
2051 * @param role Determines which sensor to apply changes to.
2052 * @param exposure Minumum Dynamic Exposure value (microseconds).
2053 * @return Operation status.
2054 */
2055 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
2056
2057 /**
2058 * Gets the minimum valid value for the ActiveAreaHeight setting.
2059 *
2060 * @public @memberof GoSetup
2061 * @version Introduced in firmware 4.0.10.27
2062 * @param setup GoSetup object.
2063 * @param role Determines which device to retrieve the value from.
2064 * @return Minimum valid ActiveAreaHeight value (mm).
2065 */
2066 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
2067
2068 /**
2069 * Gets the maximum valid value for the ActiveAreaHeight setting.
2070 *
2071 * @public @memberof GoSetup
2072 * @version Introduced in firmware 4.0.10.27
2073 * @param setup GoSetup object.
2074 * @param role Determines which device to retrieve the value from.
2075 * @return Maximum valid active area height value (mm).
2076 */
2077 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
2078
2079 /**
2080 * Gets the active area height.
2081 *
2082 * @public @memberof GoSetup
2083 * @version Introduced in firmware 4.0.10.27
2084 * @param setup GoSetup object.
2085 * @param role Determines which device to retrieve the value from.
2086 * @return Active area height (mm).
2087 */
2088 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
2089
2090 /**
2091 * Sets the active area height.
2092 *
2093 * @public @memberof GoSetup
2094 * @version Introduced in firmware 4.0.10.27
2095 * @param setup GoSetup object.
2096 * @param role Determines which sensor to apply changes to.
2097 * @param value Active area height (mm).
2098 * @return Operation status.
2099 */
2100 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
2101
2102 /**
2103 * Gets the minimum valid value for the ActiveAreaLength setting.
2104 *
2105 * @public @memberof GoSetup
2106 * @version Introduced in firmware 4.0.10.27
2107 * @param setup GoSetup object.
2108 * @param role Determines which device to retrieve the value from.
2109 * @return Minimum valid ActiveAreaLength value (mm).
2110 */
2111 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
2112
2113 /**
2114 * Gets the maximum valid value for the ActiveAreaLength setting.
2115 *
2116 * @public @memberof GoSetup
2117 * @version Introduced in firmware 4.0.10.27
2118 * @param setup GoSetup object.
2119 * @param role Determines which device to retrieve the value from.
2120 * @return Maximum valid ActiveAreaLength value (mm).
2121 */
2122 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
2123
2124 /**
2125 * Sets the active area Length.
2126 *
2127 * @public @memberof GoSetup
2128 * @version Introduced in firmware 4.0.10.27
2129 * @param setup GoSetup object.
2130 * @param role Determines which sensor to apply changes to.
2131 * @param value Active area Length (mm).
2132 * @return Operation status.
2133 */
2134 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
2135
2136 /**
2137 * Gets the active area Length.
2138 *
2139 * @public @memberof GoSetup
2140 * @version Introduced in firmware 4.0.10.27
2141 * @param setup GoSetup object.
2142 * @param role Determines which device to retrieve the value from.
2143 * @return Active area Length (mm).
2144 */
2145 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
2146
2147
2148 /**
2149 * Gets the minimum valid value for the ActiveAreaWidth setting.
2150 *
2151 * @public @memberof GoSetup
2152 * @version Introduced in firmware 4.0.10.27
2153 * @param setup GoSetup object.
2154 * @param role Determines which device to retrieve the value from.
2155 * @return Minimum valid ActiveAreaWidth value (mm).
2156 */
2157 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
2158
2159 /**
2160 * Gets the maximum valid value for the ActiveAreaWidth setting.
2161 *
2162 * @public @memberof GoSetup
2163 * @version Introduced in firmware 4.0.10.27
2164 * @param setup GoSetup object.
2165 * @param role Determines which device to retrieve the value from.
2166 * @return Maximum valid ActiveAreaWidth value (mm).
2167 */
2168 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
2169
2170 /**
2171 * Sets the active area width.
2172 *
2173 * @public @memberof GoSetup
2174 * @version Introduced in firmware 4.0.10.27
2175 * @param setup GoSetup object.
2176 * @param role Determines which sensor to apply changes to.
2177 * @param value Active area width (mm).
2178 * @return Operation status.
2179 */
2180 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
2181
2182 /**
2183 * Gets the active area width.
2184 *
2185 * @public @memberof GoSetup
2186 * @version Introduced in firmware 4.0.10.27
2187 * @param setup GoSetup object.
2188 * @param role Determines which device to retrieve the value from.
2189 * @return Active area width (mm).
2190 */
2191 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
2192
2193 /**
2194 * Gets the minimum valid value for the ActiveAreaX setting.
2195 *
2196 * @public @memberof GoSetup
2197 * @version Introduced in firmware 4.0.10.27
2198 * @param setup GoSetup object.
2199 * @param role Determines which device to retrieve the value from.
2200 * @return Minimum valid ActiveAreaX value (mm).
2201 */
2202 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
2203
2204 /**
2205 * Gets the maximum valid value for the ActiveAreaX setting.
2206 *
2207 * @public @memberof GoSetup
2208 * @version Introduced in firmware 4.0.10.27
2209 * @param setup GoSetup object.
2210 * @param role Determines which device to retrieve the value from.
2211 * @return Maximum valid ActiveAreaX value (mm).
2212 */
2213 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
2214
2215 /**
2216 * Sets the active area x origin.
2217 *
2218 * @public @memberof GoSetup
2219 * @version Introduced in firmware 4.0.10.27
2220 * @param setup GoSetup object.
2221 * @param role Determines which sensor to apply changes to.
2222 * @param value Active area x origin (mm).
2223 * @return Operation status.
2224 */
2225 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
2226
2227 /**
2228 * Gets the active area x origin.
2229 *
2230 * @public @memberof GoSetup
2231 * @version Introduced in firmware 4.0.10.27
2232 * @param setup GoSetup object.
2233 * @param role Determines which device to retrieve the value from.
2234 * @return Active area x origin (mm).
2235 */
2236 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
2237
2238 /**
2239 * Gets the minimum valid value for the ActiveAreaY setting.
2240 *
2241 * @public @memberof GoSetup
2242 * @version Introduced in firmware 4.0.10.27
2243 * @param setup GoSetup object.
2244 * @param role Determines which device to retrieve the value from.
2245 * @return Minimum valid ActiveAreaY value (mm).
2246 */
2247 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
2248
2249 /**
2250 * Gets the maximum valid value for the ActiveAreaY setting.
2251 *
2252 * @public @memberof GoSetup
2253 * @version Introduced in firmware 4.0.10.27
2254 * @param setup GoSetup object.
2255 * @param role Determines which device to retrieve the value from.
2256 * @return Maximum valid ActiveAreaY value (mm).
2257 */
2258 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
2259
2260 /**
2261 * Sets the active area Y.
2262 *
2263 * @public @memberof GoSetup
2264 * @version Introduced in firmware 4.0.10.27
2265 * @param setup GoSetup object.
2266 * @param role Determines which sensor to apply changes to.
2267 * @param value Active area y origin (mm).
2268 * @return Operation status.
2269 */
2270 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
2271
2272 /**
2273 * Gets the active area Y.
2274 *
2275 * @public @memberof GoSetup
2276 * @version Introduced in firmware 4.0.10.27
2277 * @param setup GoSetup object.
2278 * @param role Determines which device to retrieve the value from.
2279 * @return Active area y origin (mm).
2280 */
2281 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
2282
2283 /**
2284 * Gets the minimum valid value for the ActiveAreaZ setting.
2285 *
2286 * @public @memberof GoSetup
2287 * @version Introduced in firmware 4.0.10.27
2288 * @param setup GoSetup object.
2289 * @param role Determines which device to retrieve the value from.
2290 * @return Minimum valid ActiveAreaZ value (mm).
2291 */
2292 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
2293
2294 /**
2295 * Gets the maximum valid value for the ActiveAreaZ setting.
2296 *
2297 * @public @memberof GoSetup
2298 * @version Introduced in firmware 4.0.10.27
2299 * @param setup GoSetup object.
2300 * @param role Determines which device to retrieve the value from.
2301 * @return Maximum valid ActiveAreaZ value (mm).
2302 */
2303 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
2304
2305 /**
2306 * Sets the active area z origin.
2307 *
2308 * @public @memberof GoSetup
2309 * @version Introduced in firmware 4.0.10.27
2310 * @param setup GoSetup object.
2311 * @param role Determines which sensor to apply changes to.
2312 * @param value Active area z origin (mm).
2313 * @return Operation status.
2314 */
2315 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
2316
2317 /**
2318 * Gets the active area z origin.
2319 *
2320 * @public @memberof GoSetup
2321 * @version Introduced in firmware 4.0.10.27
2322 * @param setup GoSetup object.
2323 * @param role Determines which device to retrieve the value from.
2324 * @return Active area z origin (mm).
2325 */
2326 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);
2327
2328 /**
2329 * Gets the transformed data region X value.
2330 *
2331 * @public @memberof GoSetup
2332 * @version Introduced in firmware 4.0.10.27
2333 * @param setup GoSetup object.
2334 * @param role The device whose value to retrieve.
2335 * @return The transformed data region X value.
2336 */
2337 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
2338
2339 /**
2340 * Gets the transformed data region Y value.
2341 *
2342 * @public @memberof GoSetup
2343 * @version Introduced in firmware 4.0.10.27
2344 * @param setup GoSetup object.
2345 * @param role The device whose value to retrieve.
2346 * @return The transformed data region Y value.
2347 */
2348 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
2349
2350 /**
2351 * Gets the transformed data region Z value.
2352 *
2353 * @public @memberof GoSetup
2354 * @version Introduced in firmware 4.0.10.27
2355 * @param setup GoSetup object.
2356 * @param role The device whose value to retrieve.
2357 * @return The transformed data region Z value.
2358 */
2359 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
2360
2361 /**
2362 * Gets the transformed data region width value.
2363 *
2364 * @public @memberof GoSetup
2365 * @version Introduced in firmware 4.0.10.27
2366 * @param setup GoSetup object.
2367 * @param role The device whose value to retrieve.
2368 * @return The transformed data region width value.
2369 */
2370 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
2371
2372 /**
2373 * Gets the transformed data region length value.
2374 *
2375 * @public @memberof GoSetup
2376 * @version Introduced in firmware 4.0.10.27
2377 * @param setup GoSetup object.
2378 * @param role The device whose value to retrieve.
2379 * @return The transformed data region length value.
2380 */
2381 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
2382
2383 /**
2384 * Gets the transformed data region height value.
2385 *
2386 * @public @memberof GoSetup
2387 * @version Introduced in firmware 4.0.10.27
2388 * @param setup GoSetup object.
2389 * @param role The device whose value to retrieve.
2390 * @return The transformed data region height value.
2391 */
2392 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
2393
2394 /**
2395 * Gets the count of valid x-resolution options.
2396 *
2397 * @public @memberof GoSetup
2398 * @version Introduced in firmware 4.0.10.27
2399 * @param setup GoSetup object.
2400 * @param role Determines which device to retrieve the value from.
2401 * @return Count of x-resolution options.
2402 */
2403 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
2404
2405 /**
2406 * Gets the x-resolution option at the specified index.
2407 *
2408 * @public @memberof GoSetup
2409 * @version Introduced in firmware 4.0.10.27
2410 * @param setup GoSetup object.
2411 * @param role Determines which device to retrieve the value from.
2412 * @param index Index of the desired resolution option.
2413 * @return X resolution option.
2414 * @see GoSetup_XSubsamplingOptionCount
2415 */
2416 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2417
2418 /**
2419 * Sets the current x-resolution divider.
2420 *
2421 * @public @memberof GoSetup
2422 * @version Introduced in firmware 4.0.10.27
2423 * @param setup GoSetup object.
2424 * @param role Determines which sensor to apply changes to.
2425 * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
2426 * @return Operation status.
2427 */
2428 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
2429
2430 /**
2431 * Gets the current x-resolution divider.
2432 *
2433 * @public @memberof GoSetup
2434 * @version Introduced in firmware 4.0.10.27
2435 * @param setup GoSetup object.
2436 * @param role Determines which device to retrieve the value from.
2437 * @return X resolution divider (e.g. 1 - full res, 2 - half res).
2438 */
2439 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
2440
2441 /**
2442 * Gets the count of valid z-resolution options.
2443 *
2444 * @public @memberof GoSetup
2445 * @version Introduced in firmware 4.0.10.27
2446 * @param setup GoSetup object.
2447 * @param role Determines which device to retrieve the value from.
2448 * @return Count of z-resolution options.
2449 */
2450 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
2451
2452 /**
2453 * Gets the z-resolution option at the specified index.
2454 *
2455 * @public @memberof GoSetup
2456 * @version Introduced in firmware 4.0.10.27
2457 * @param setup GoSetup object.
2458 * @param role Determines which device to retrieve the value from.
2459 * @param index Index of the desired resolution option.
2460 * @return Z resolution option.
2461 * see GoSetup_ZSubsamplingOptionCount
2462 */
2463 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2464
2465 /**
2466 * Sets the current z-resolution divider.
2467 *
2468 * @public @memberof GoSetup
2469 * @version Introduced in firmware 4.0.10.27
2470 * @param setup GoSetup object.
2471 * @param role Determines which sensor to apply changes to.
2472 * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
2473 * @return Operation status.
2474 */
2475 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
2476
2477 /**
2478 * Gets the current z-resolution divider.
2479 *
2480 * @public @memberof GoSetup
2481 * @version Introduced in firmware 4.0.10.27
2482 * @param setup GoSetup object.
2483 * @param role Determines which device to retrieve the value from.
2484 * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
2485 */
2486 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
2487
2488 /**
2489 * Gets the camera region-of-interest x origin.
2490 *
2491 * @public @memberof GoSetup
2492 * @version Introduced in firmware 4.0.10.27
2493 * @param setup GoSetup object.
2494 * @param role Determines which device to retrieve the value from.
2495 * @return Region of interest x origin (pixels).
2496 */
2497 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
2498
2499 /**
2500 * Gets the camera region-of-interest y origin.
2501 *
2502 * @public @memberof GoSetup
2503 * @version Introduced in firmware 4.0.10.27
2504 * @param setup GoSetup object.
2505 * @param role Determines which device to retrieve the value from.
2506 * @return Region of interest y origin (pixels).
2507 */
2508 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
2509
2510 /**
2511 * Gets the camera region-of-interest width.
2512 *
2513 * @public @memberof GoSetup
2514 * @version Introduced in firmware 4.0.10.27
2515 * @param setup GoSetup object.
2516 * @param role Determines which device to retrieve the value from.
2517 * @return Region of interest width (pixels).
2518 */
2519 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
2520
2521 /**
2522 * Gets the camera region-of-interest height.
2523 *
2524 * @public @memberof GoSetup
2525 * @version Introduced in firmware 4.0.10.27
2526 * @param setup GoSetup object.
2527 * @param role Determines which device to retrieve the value from.
2528 * @return Region of interest height (pixels).
2529 */
2530 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
2531
2532 /**
2533 * Returns a boolean representing whether the back camera element is used.
2534 *
2535 * @public @memberof GoSetup
2536 * @version Introduced in firmware 4.1.3.106
2537 * @param setup GoSetup object.
2538 * @param role Determines which device to retrieve the value from.
2539 * @return kTRUE if used, or kFALSE if not used.
2540 */
2541 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
2542
2543 /**
2544 * Gets the camera region-of-interest x origin.
2545 *
2546 * @public @memberof GoSetup
2547 * @version Introduced in firmware 4.0.10.27
2548 * @param setup GoSetup object.
2549 * @param role Determines which device to retrieve the value from.
2550 * @return Region of interest x origin (pixels).
2551 */
2552 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
2553
2554 /**
2555 * Gets the camera region-of-interest y origin.
2556 *
2557 * @public @memberof GoSetup
2558 * @version Introduced in firmware 4.0.10.27
2559 * @param setup GoSetup object.
2560 * @param role Determines which device to retrieve the value from.
2561 * @return Region of interest y origin (pixels).
2562 */
2563 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
2564
2565 /**
2566 * Gets the camera region-of-interest width.
2567 *
2568 * @public @memberof GoSetup
2569 * @version Introduced in firmware 4.0.10.27
2570 * @param setup GoSetup object.
2571 * @param role Determines which device to retrieve the value from.
2572 * @return Region of interest width (pixels).
2573 */
2574 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
2575
2576 /**
2577 * Gets the camera region-of-interest height.
2578 *
2579 * @public @memberof GoSetup
2580 * @version Introduced in firmware 4.0.10.27
2581 * @param setup GoSetup object.
2582 * @param role Determines which device to retrieve the value from.
2583 * @return Region of interest height (pixels).
2584 */
2585 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
2586
2587 /**
2588 * Enables tracking.
2589 *
2590 * @public @memberof GoSetup
2591 * @version Introduced in firmware 4.0.10.27
2592 * @param setup GoSetup object.
2593 * @param role Determines which sensor to apply changes to.
2594 * @param enable kTRUE to enable, or kFALSE to disable.
2595 * @return Operation status.
2596 */
2597 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
2598
2599 /**
2600 * Determines if tracking is enabled.
2601 *
2602 * @public @memberof GoSetup
2603 * @version Introduced in firmware 4.0.10.27
2604 * @param setup GoSetup object.
2605 * @param role Determines which device to retrieve the value from.
2606 * @return kTRUE if enabled, or kFALSE if disabled.
2607 */
2608 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
2609
2610 /**
2611 * Returns a boolean value representing whether the Tracking Enabled field is used.
2612 *
2613 * @public @memberof GoSetup
2614 * @version Introduced in firmware 4.1.3.106
2615 * @param setup GoSetup object.
2616 * @param role Determines which device to retrieve the value from.
2617 * @return kTRUE if used, or kFALSE if not used.
2618 */
2619 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
2620
2621 /**
2622 * Sets the tracking window height.
2623 *
2624 * @public @memberof GoSetup
2625 * @version Introduced in firmware 4.0.10.27
2626 * @param setup GoSetup object.
2627 * @param role Determines which sensor to apply changes to.
2628 * @param height Tracking window height (mm).
2629 * @return Operation status.
2630 */
2631 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
2632
2633 /**
2634 * Gets the tracking window height.
2635 *
2636 * @public @memberof GoSetup
2637 * @version Introduced in firmware 4.0.10.27
2638 * @param setup GoSetup object.
2639 * @param role Determines which device to retrieve the value from.
2640 * @return Tracking window height (mm).
2641 */
2642 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
2643
2644 /**
2645 * Gets the tracking window height minimum limit.
2646 *
2647 * @public @memberof GoSetup
2648 * @version Introduced in firmware 4.0.10.27
2649 * @param setup GoSetup object.
2650 * @param role Determines which device to retrieve the value from.
2651 * @return Tracking window height min(mm).
2652 */
2653 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
2654
2655 /**
2656 * Gets the tracking window height maximum limit.
2657 *
2658 * @public @memberof GoSetup
2659 * @version Introduced in firmware 4.0.10.27
2660 * @param setup GoSetup object.
2661 * @param role Determines which device to retrieve the value from.
2662 * @return Tracking window height max(mm).
2663 */
2664 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
2665
2666 /**
2667 * Sets the tracking window search threshold.
2668 *
2669 * @public @memberof GoSetup
2670 * @version Introduced in firmware 4.0.10.27
2671 * @param setup GoSetup object.
2672 * @param role Determines which sensor to apply changes to.
2673 * @param threshold Tracking window search threshold (%)
2674 * @return Operation status.
2675 */
2676 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
2677
2678 /**
2679 * Gets the tracking window search threshold.
2680 *
2681 * @public @memberof GoSetup
2682 * @version Introduced in firmware 4.0.10.27
2683 * @param setup GoSetup object.
2684 * @param role Determines which device to retrieve the value from.
2685 * @return Tracking window search threshold (%).
2686 */
2687 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
2688
2689 /**
2690 * Returns the state of whether the user specified spacing interval is used.
2691 *
2692 * @public @memberof GoSetup
2693 * @version Introduced in firmware 4.0.10.27
2694 * @param setup GoSetup object.
2695 * @param role Determines which device to retrieve the value from.
2696 * @return kTRUE if the user value is used and kFALSE otherwise.
2697 */
2698 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
2699
2700 /**
2701 * Gets the spacing interval system value.
2702 *
2703 * @public @memberof GoSetup
2704 * @version Introduced in firmware 4.0.10.27
2705 * @param setup GoSetup object.
2706 * @param role Determines which device to retrieve the value from.
2707 * @return Spacing interval.
2708 */
2709 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
2710
2711 /**
2712 * Gets the spacing interval.
2713 *
2714 * @public @memberof GoSetup
2715 * @version Introduced in firmware 4.0.10.27
2716 * @param setup GoSetup object.
2717 * @param role Determines which device to retrieve the value from.
2718 * @return Spacing interval.
2719 */
2720 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
2721
2722 /// @cond (Gocator_3x00)
2723 /**
2724 * Sets the spacing interval.
2725 *
2726 * @public @memberof GoSetup
2727 * @version Introduced in firmware 4.0.10.27
2728 * @param setup GoSetup object.
2729 * @param role Determines which sensor to apply changes to.
2730 * @param value The spacing interval.
2731 * @return Operation status.
2732 */
2733 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
2734 /// @endcond
2735
2736 /**
2737 * Gets the spacing interval value limit minimum.
2738 *
2739 * @public @memberof GoSetup
2740 * @version Introduced in firmware 4.0.10.27
2741 * @param setup GoSetup object.
2742 * @param role Determines which device to retrieve the value from.
2743 * @return Spacing interval value limit minimum.
2744 */
2745 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
2746
2747 /**
2748 * Gets the spacing interval value limit maximum
2749 *
2750 * @public @memberof GoSetup
2751 * @version Introduced in firmware 4.0.10.27
2752 * @param setup GoSetup object.
2753 * @param role Determines which device to retrieve the value from.
2754 * @return Spacing interval value limit maximum.
2755 */
2756 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
2757
2758 /**
2759 * Gets the spacing interval type.
2760 *
2761 * @public @memberof GoSetup
2762 * @version Introduced in firmware 4.0.10.27
2763 * @param setup GoSetup object.
2764 * @param role Determines which device to retrieve the value from.
2765 * @return The spacing interval type.
2766 */
2767 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
2768
2769 /**
2770 * Sets the spacing interval type.
2771 *
2772 * @public @memberof GoSetup
2773 * @version Introduced in firmware 4.0.10.27
2774 * @param setup GoSetup object.
2775 * @param role Determines which sensor to apply changes to.
2776 * @param type The spacing interval type.
2777 * @return Operation status.
2778 */
2779 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
2780
2781 /**
2782 * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
2783 *
2784 * @public @memberof GoSetup
2785 * @version Introduced in firmware 4.0.10.27
2786 * @param setup GoSetup object.
2787 * @param role The device role from which to retrieve the setting.
2788 * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
2789 */
2790 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
2791
2792 /**
2793 * Gets the X spacing count.
2794 *
2795 * @public @memberof GoSetup
2796 * @version Introduced in firmware 4.0.10.27
2797 * @param setup GoSetup object.
2798 * @param role Determines which device to retrieve the value from.
2799 * @return X spacing count.
2800 */
2801 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
2802
2803 /**
2804 * Gets the Y spacing count.
2805 *
2806 * @public @memberof GoSetup
2807 * @version Introduced in firmware 4.0.10.27
2808 * @param setup GoSetup object.
2809 * @param role Determines which device to retrieve the value from.
2810 * @return Y spacing count.
2811 */
2812 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
2813
2814 /**
2815 * Gets the intensity step index.
2816 *
2817 * @public @memberof GoSetup
2818 * @version Introduced in firmware 4.0.10.27
2819 * @param setup GoSetup object.
2820 * @param role Determines which device to retrieve the value from.
2821 * @return The intensity step index.
2822 */
2823 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
2824
2825 /**
2826 * Sets the intensity step index.
2827 *
2828 * @public @memberof GoSetup
2829 * @version Introduced in firmware 4.0.10.27
2830 * @param setup GoSetup object.
2831 * @param role Determines which sensor to apply changes to.
2832 * @param index The exposure step index to use for intensity acquisition.
2833 * @return Operation status.
2834 * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
2835 */
2836 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
2837
2838 /**
2839 * Gets the pattern sequence type option count.
2840 *
2841 * @public @memberof GoSetup
2842 * @version Introduced in firmware 4.2.4.7
2843 * @param setup GoSetup object.
2844 * @param role Determines which device to retrieve the value from.
2845 * @return Pattern sequence type option count.
2846 */
2847 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
2848
2849 /**
2850 * Gets the pattern sequence type option at the given index.
2851 *
2852 * @public @memberof GoSetup
2853 * @version Introduced in firmware 4.2.4.7
2854 * @param setup GoSetup object.
2855 * @param role Determines which device to retrieve the value from.
2856 * @param index The index with which to retrieve a sequence type option.
2857 * @return A sequence type option value.
2858 * @see GoSetup_PatternSequenceOptionCount
2859 */
2860 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
2861
2862 /**
2863 * Gets the pattern sequence type.
2864 *
2865 * @public @memberof GoSetup
2866 * @version Introduced in firmware 4.2.4.7
2867 * @param setup GoSetup object.
2868 * @param role Determines which device to retrieve the value from.
2869 * @return The pattern sequence type.
2870 */
2871 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
2872
2873 /**
2874 * Sets the pattern sequence type.
2875 *
2876 * @public @memberof GoSetup
2877 * @version Introduced in firmware 4.2.4.7
2878 * @param setup GoSetup object.
2879 * @param role Determines which sensor to apply changes to.
2880 * @param type The pattern sequence type to set.
2881 * @return Operation status.
2882 */
2883 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
2884
2885 /**
2886 * Returns a boolean value representing whether the pattern sequence type is used.
2887 *
2888 * @public @memberof GoSetup
2889 * @version Introduced in firmware 4.2.4.7
2890 * @param setup GoSetup object.
2891 * @param role Determines which device to retrieve the value from.
2892 * @return kTRUE if used and kFALSE otherwise.
2893 */
2894 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
2895
2896 /**
2897 * Gets the current pattern sequence count.
2898 *
2899 * @public @memberof GoSetup
2900 * @version Introduced in firmware 4.2.4.7
2901 * @param setup GoSetup object.
2902 * @param role Determines which device to retrieve the value from.
2903 * @return The current pattern sequence count.
2904 */
2905 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
2906
2907
2908 /**
2909 * Gets the layout configuration module.
2910 *
2911 * @public @memberof GoSetup
2912 * @version Introduced in firmware 4.0.10.27
2913 * @param setup GoSetup object.
2914 * @return Layout configuration module.
2915 */
2916 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
2917
2918 /**
2919 * Gets the profile generation module, used for profile generation configuration.
2920 *
2921 * @public @memberof GoSetup
2922 * @version Introduced in firmware 4.2.4.7
2923 * @param setup GoSetup object.
2924 * @return Profile generation configuration module.
2925 */
2926 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
2927
2928 /**
2929 * Gets the surface generation module, used for surface generation configuration.
2930 *
2931 * @public @memberof GoSetup
2932 * @version Introduced in firmware 4.0.10.27
2933 * @param setup GoSetup object.
2934 * @return Surface generation configuration module.
2935 */
2936 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
2937
2938 /**
2939 * Gets the part detection module, used for part detection configuration.
2940 *
2941 * @public @memberof GoSetup
2942 * @version Introduced in firmware 4.0.10.27
2943 * @param setup GoSetup object.
2944 * @return Part detection configuration module.
2945 */
2946 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
2947
2948 /**
2949 * Gets the part matching module, used for part matching configuration.
2950 *
2951 * @public @memberof GoSetup
2952 * @version Introduced in firmware 4.2.4.7
2953 * @param setup GoSetup object.
2954 * @return Part matching configuration module.
2955 */
2956 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
2957
2958 /**
2959 * Gets the advanced acquisition module, used for advanced acquisition configuration.
2960 *
2961 * @public @memberof GoSetup
2962 * @version Introduced in firmware 4.6
2963 * @param setup GoSetup object.
2964 * @param role The device role whose advanced settings object to return.
2965 * @return Advanced acquisition configuration module.
2966 */
2967 GoFx(GoAdvanced) GoSetup_Advanced(GoSetup setup, GoRole role);
2968
2969 /**
2970 * @deprecated Gets the material acquisition module, used for material acquisition configuration.
2971 *
2972 * @public @memberof GoSetup
2973 * @version Introduced in firmware 4.1.3.106
2974 * @param setup GoSetup object.
2975 * @param role The device role whose material settings object to return.
2976 * @return Material acquisition configuration module.
2977 */
2978 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
2979
2980 /**
2981 * Gets the Section configuration module, used for surface sections.
2982 *
2983 * @public @memberof GoSetup
2984 * @version Introduced in firmware 4.4.4.14
2985 * @param setup GoSetup object.
2986 * @return Section configuration module.
2987 */
2988 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
2989
2990 /**
2991 * Gets the tracheid configuration module.
2992 *
2993 * @public @memberof GoSetup
2994 * @version Introduced in firmware 4.5.3.57
2995 * @param setup GoSetup object.
2996 * @param role Determines which device to retrieve the value from.
2997 * @return Tracheid configuration module.
2998 */
2999 GoFx(GoTracheid) GoSetup_Tracheid(GoSetup setup, GoRole role);
3000
3001 /**
3002 * Returns a boolean value representing the state of the independent exposures used field.
3003 * If this feature is available, it will use the exposure values and limits assigned to
3004 * both the front and back cameras.
3005 *
3006 * @public @memberof GoSetup
3007 * @version Introduced in firmware 4.6.0.140
3008 * @param setup GoSetup object.
3009 * @param role Determines which device to retrieve the value from.
3010 * @return kTRUE if used, or kFALSE if not used.
3011 */
3012 GoFx(kBool) GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role);
3013
3014 /**
3015 * Enables independent exposures feature, i.e. separate exposures
3016 * for separate cameras.
3017 *
3018 * @public @memberof GoSetup
3019 * @version Introduced in firmware 4.6.0.140
3020 * @param setup GoSetup object.
3021 * @param role Determines which sensor to apply changes to.
3022 * @param enable kTRUE to enable, or kFALSE to disable.
3023 * @return Operation status.
3024 */
3025 GoFx(kStatus) GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable);
3026
3027 /**
3028 * Determines if independent exposures feature is enabled.
3029 *
3030 * @public @memberof GoSetup
3031 * @version Introduced in firmware 4.6.0.140
3032 * @param setup GoSetup object.
3033 * @param role Determines which device to retrieve the value from.
3034 * @return kTRUE if enabled, or kFALSE if disabled.
3035 */
3036 GoFx(kBool) GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role);
3037
3038 /**
3039 * Gets the maximum valid value for the front camera exposure setting.
3040 *
3041 * @public @memberof GoSetup
3042 * @version Introduced in firmware 4.6.0.140
3043 * @param setup GoSetup object.
3044 * @param role Determines which device to retrieve the value from.
3045 * @return Maximum valid auxiliary exposure value (microseconds).
3046 */
3047 GoFx(k64f) GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role);
3048
3049 /**
3050 * Gets the minimum valid value for the front camara exposure setting.
3051 *
3052 * @public @memberof GoSetup
3053 * @version Introduced in firmware 4.6.0.140
3054 * @param setup GoSetup object.
3055 * @param role Determines which device to retrieve the value from.
3056 * @return Minimum valid auxiliary exposure value (microseconds).
3057 */
3058 GoFx(k64f) GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role);
3059
3060 /**
3061 * Sets the front camera exposure value.
3062 *
3063 * @public @memberof GoSetup
3064 * @version Introduced in firmware 4.6.0.140
3065 * @param setup GoSetup object.
3066 * @param role Determines which sensor to apply changes to.
3067 * @param exposure Intended auxiliary exposure value.
3068 * @return Operation status.
3069 */
3070 GoFx(kStatus) GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3071
3072 /**
3073 * Gets the front camera exposure value.
3074 *
3075 * @public @memberof GoSetup
3076 * @version Introduced in firmware 4.6.0.140
3077 * @param setup GoSetup object.
3078 * @param role Determines which device to retrieve the value from.
3079 * @return Auxiliary exposure value (microseconds).
3080 */
3081 GoFx(k64f) GoSetup_FrontCameraExposure(GoSetup setup, GoRole role);
3082
3083 /**
3084 * Gets the maximum valid value for the back camera exposure setting.
3085 *
3086 * @public @memberof GoSetup
3087 * @version Introduced in firmware 4.6.0.140
3088 * @param setup GoSetup object.
3089 * @param role Determines which device to retrieve the value from.
3090 * @return Maximum valid auxiliary exposure value (microseconds).
3091 */
3092 GoFx(k64f) GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role);
3093
3094 /**
3095 * Gets the minimum valid value for the back camara exposure setting.
3096 *
3097 * @public @memberof GoSetup
3098 * @version Introduced in firmware 4.6.0.140
3099 * @param setup GoSetup object.
3100 * @param role Determines which device to retrieve the value from.
3101 * @return Minimum valid auxiliary exposure value (microseconds).
3102 */
3103 GoFx(k64f) GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role);
3104
3105 /**
3106 * Sets the back camera exposure value.
3107 *
3108 * @public @memberof GoSetup
3109 * @version Introduced in firmware 4.6.0.140
3110 * @param setup GoSetup object.
3111 * @param role Determines which sensor to apply changes to.
3112 * @param exposure Intended auxiliary exposure value.
3113 * @return Operation status.
3114 */
3115 GoFx(kStatus) GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3116
3117 /**
3118 * Gets the back camera exposure value.
3119 *
3120 * @public @memberof GoSetup
3121 * @version Introduced in firmware 4.6.0.140
3122 * @param setup GoSetup object.
3123 * @param role Determines which device to retrieve the value from.
3124 * @return Auxiliary exposure value (microseconds).
3125 */
3126 GoFx(k64f) GoSetup_BackCameraExposure(GoSetup setup, GoRole role);
3127
3128 /**
3129 * Gets the source used for generating intensity data.
3130 *
3131 * @public @memberof GoSetup
3132 * @version Introduced in firmware 4.6.0.152
3133 * @param setup GoSetup object.
3134 * @param role Determines which device to retrieve the value from.
3135 * @return Source of intensity data.
3136 */
3137 GoFx(GoIntensitySource) GoSetup_IntensitySource(GoSetup setup, GoRole role);
3138
3139 /**
3140 * Sets the source to be used for generating intensity data.
3141 *
3142 * @public @memberof GoSetup
3143 * @version Introduced in firmware 4.6.0.152
3144 * @param setup GoSetup object.
3145 * @param role Determines which sensor to apply changes to.
3146 * @param source The source to be used.
3147 * @return Operation status.
3148 */
3149 GoFx(kStatus) GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source);
3150
3151 /**
3152 * Gets the intensity source option at the given index.
3153 *
3154 * @public @memberof GoSetup
3155 * @version Introduced in firmware 4.6.0.152
3156 * @param setup GoSetup object.
3157 * @param role Determines which device to retrieve the value from.
3158 * @param index The index with which to retrieve an exposure mode option.
3159 * @return Intensity source set.
3160 * @see GoSetup_IntensitySourceOptionCount
3161 */
3162 GoFx(GoIntensitySource) GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index);
3163
3164 /**
3165 * Gets the intensity source option count.
3166 *
3167 * @public @memberof GoSetup
3168 * @version Introduced in firmware 4.6.0.152
3169 * @param setup GoSetup object.
3170 * @param role Determines which device to retrieve the value from.
3171 * @return Intensity source option count.
3172 */
3173 GoFx(kSize) GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role);
3174
3175
3176 kEndHeader()
3177 #include <GoSdk/GoSetup.x.h>
3178
3179 #endif
GoSetup::GoSetup_InputTriggerEnabledSystemValue
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger system value.
GoSetup::GoSetup_BarHoleCountValue
kSize GoSetup_BarHoleCountValue(GoSetup setup)
Gets the number of columns currently configured in the n-buddy layout.
GoSetup::GoSetup_EnableAlignmentEncoderCalibrate
kStatus GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled)
Enables encoder calibration after alignment.
GoSetup::GoSetup_OcclusionReductionEnabledUsed
kBool GoSetup_OcclusionReductionEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction configuration is used...
GoSetup::GoSetup_ActiveAreaHeightLimitMin
k64f GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_ActiveAreaZLimitMin
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_ActiveAreaWidth
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
GoSetup::GoSetup_TriggerGateEnabled
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
k32u
GoSetup::GoSetup_ActiveAreaXLimitMax
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_LayoutGridColumnSystemValue
k32s GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role)
Gets layout grid column index.
GoSetup::GoSetup_ActiveAreaHeightLimitMax
k64f GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_SetActiveAreaLength
kStatus GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value)
Sets the active area Length.
GoSetup::GoSetup_TriggerUnit
GoTriggerUnits GoSetup_TriggerUnit(GoSetup setup)
Gets the system trigger units.
GoSetup::GoSetup_SetPlateHoleCount
kStatus GoSetup_SetPlateHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_SetAlignmentType
kStatus GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type)
Sets the type used for alignment.
GoSetup::GoSetup_ActiveAreaWidthLimitMax
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
GoIntensitySource
Represents all possible sources of intensity data.
GoSetup::GoSetup_LayoutGridRowSystemValue
k32s GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role)
Gets layout grid row index.
GoSetup::GoSetup_Exposure
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
GoSetup::GoSetup_ActiveAreaY
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
GoSetup::GoSetup_ZSubsamplingOptionAt
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the z-resolution option at the specified index.
GoPartDetection.h
Declares the GoPartDetection class.
GoSetup::GoSetup_EnableMaxFrameRate
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
GoSetup::GoSetup_TrackingAreaHeight
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
GoSetup::GoSetup_ActiveAreaYLimitMin
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_PatternSequenceTypeOptionCount
kSize GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role)
Gets the pattern sequence type option count.
GoSetup::GoSetup_AddExposureStep
kStatus GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure)
Adds an exposure step.
GoSetup::GoSetup_TriggerDelay
k64f GoSetup_TriggerDelay(GoSetup setup)
Gets the trigger delay.
GoSetup::GoSetup_SetActiveAreaWidth
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
GoSections.h
Declares the GoSections class.
GoSetup::GoSetup_BackCameraX
k32u GoSetup_BackCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_XSubsamplingOptionCount
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
GoSetup::GoSetup_BackCameraExposure
k64f GoSetup_BackCameraExposure(GoSetup setup, GoRole role)
Gets the back camera exposure value.
GoSetup::GoSetup_TransformedDataRegionX
k64f GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role)
Gets the transformed data region X value.
GoTracheid
Represents tracheid data.
GoSetup::GoSetup_TransformedDataRegionLength
k64f GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role)
Gets the transformed data region length value.
GoSetup::GoSetup_IntensityEnabled
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
GoSetup::GoSetup_SetZSubsampling
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
GoSetup::GoSetup_AlignmentTypeOptionCount
kSize GoSetup_AlignmentTypeOptionCount(GoSetup setup)
Gets the alignment type option count.
GoSetup::GoSetup_EnableTriggerGate
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
GoSetup::GoSetup_BarHoleCount
kSize GoSetup_BarHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration bar.
GoSetup::GoSetup_SetBarHoleDistance
kStatus GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance)
Sets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_TrackingUsed
kBool GoSetup_TrackingUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the Tracking Enabled field is used.
GoSetup::GoSetup_EncoderTriggerMode
GoEncoderTriggerMode GoSetup_EncoderTriggerMode(GoSetup setup)
Gets the encoder trigger mode.
GoSetup::GoSetup_TriggerBurstEnabled
kBool GoSetup_TriggerBurstEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enbaled state...
GoSetup::GoSetup_IntensitySourceOptionCount
kSize GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role)
Gets the intensity source option count.
GoSetup::GoSetup_EncoderSpacingLimitMin
k64f GoSetup_EncoderSpacingLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Encoder Period setting.
GoSetup::GoSetup_SetDynamicExposureMax
kStatus GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure)
Sets the maximum value for the Dynamic Exposure setting.
GoSetup::GoSetup_FlickerFreeModeEnabled
kBool GoSetup_FlickerFreeModeEnabled(GoSetup setup)
Reports whether flicker free mode is enabled.
GoSetup::GoSetup_SetExposureMode
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
GoSetup::GoSetup_SetFrameRate
kStatus GoSetup_SetFrameRate(GoSetup setup, k64f frameRate)
Sets the current frame rate for time-based triggering.
GoSetup::GoSetup_TrackingSearchThreshold
k64f GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role)
Gets the tracking window search threshold.
GoSetup::GoSetup_ZSubsampling
k32u GoSetup_ZSubsampling(GoSetup setup, GoRole role)
Gets the current z-resolution divider.
GoSetup::GoSetup_SetActiveAreaX
kStatus GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value)
Sets the active area x origin.
GoSetup::GoSetup_IndependentExposuresUsed
kBool GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role)
Returns a boolean value representing the state of the independent exposures used field.
GoSetup::GoSetup_ZSubsamplingOptionCount
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
GoRole
Represents a user role.
GoSetup::GoSetup_AlignmentUsed
kBool GoSetup_AlignmentUsed(GoSetup setup)
Indicates whether alignment can be used.
kSize
GoSetup::GoSetup_SetSpacingIntervalType
kStatus GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type)
Sets the spacing interval type.
GoSetup::GoSetup_OcclusionReductionAlg
GoOcclusionReductionAlg GoSetup_OcclusionReductionAlg(GoSetup setup)
Gets the occlusion reduction algorithm.
GoSetup::GoSetup_FrameRateLimitMax
k64f GoSetup_FrameRateLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Frame Rate setting.
GoSetup::GoSetup_ScanModeOptionAt
GoMode GoSetup_ScanModeOptionAt(GoSetup setup, kSize index)
Gets the scan mode option at the specified index.
GoSetup::GoSetup_PatternSequenceCount
kSize GoSetup_PatternSequenceCount(GoSetup setup, GoRole role)
Gets the current pattern sequence count.
GoSetup::GoSetup_SetPlateRefHoleDiameter
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_BackCameraHeight
k32u GoSetup_BackCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
GoSetup::GoSetup_FrameRate
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
GoSetup::GoSetup_BackCameraUsed
k32u GoSetup_BackCameraUsed(GoSetup setup, GoRole role)
Returns a boolean representing whether the back camera element is used.
GoSetup::GoSetup_XSpacingCount
k32u GoSetup_XSpacingCount(GoSetup setup, GoRole role)
Gets the X spacing count.
GoSetup::GoSetup_ActiveAreaZ
k64f GoSetup_ActiveAreaZ(GoSetup setup, GoRole role)
Gets the active area z origin.
GoTrigger
Represents a trigger.
GoSetup::GoSetup_YSpacingCount
k32u GoSetup_YSpacingCount(GoSetup setup, GoRole role)
Gets the Y spacing count.
GoSetup::GoSetup_FrontCameraWidth
k32u GoSetup_FrontCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_SpacingIntervalType
GoSpacingIntervalType GoSetup_SpacingIntervalType(GoSetup setup, GoRole role)
Gets the spacing interval type.
GoSetup::GoSetup_IntensitySourceOptionAt
GoIntensitySource GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the intensity source option at the given index.
GoSetup::GoSetup_PlateSecHoleDiameter
k64f GoSetup_PlateSecHoleDiameter(GoSetup setup)
Gets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_FrontCameraX
k32u GoSetup_FrontCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_SetTrackingSearchThreshold
kStatus GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold)
Sets the tracking window search threshold.
GoSetup::GoSetup_PlateHoleCount
kSize GoSetup_PlateHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_AlignmentType
GoAlignmentType GoSetup_AlignmentType(GoSetup setup)
Gets the type used for alignment calibration.
GoSetup::GoSetup_TriggerBurstCount
k32u GoSetup_TriggerBurstCount(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst count...
GoSetup::GoSetup_AlignmentStationaryTargetOptionAt
GoAlignmentTarget GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index)
Gets the stationary alignment target option at the given index.
GoSetup::GoSetup_EnableTracking
kStatus GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable)
Enables tracking.
GoSetup::GoSetup_OcclusionReductionAlgUsed
kBool GoSetup_OcclusionReductionAlgUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction algorithm is used.
GoSetup::GoSetup_ActiveAreaLengthLimitMax
k64f GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_OcclusionReductionEnabled
kBool GoSetup_OcclusionReductionEnabled(GoSetup setup)
Gets the occlusion reduction enabled state.
GoSetup::GoSetup_Sections
GoSections GoSetup_Sections(GoSetup setup)
Gets the Section configuration module, used for surface sections.
GoSetup::GoSetup_Material
GoMaterial GoSetup_Material(GoSetup setup, GoRole role)
GoSetup::GoSetup_IntensitySource
GoIntensitySource GoSetup_IntensitySource(GoSetup setup, GoRole role)
Gets the source used for generating intensity data.
GoSetup::GoSetup_EnableTemperatureSafety
kStatus GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable)
Enables the temperature saftey of the sensor system.
GoLayout
Represents a layout related sensor configuration.
GoTracheid.h
Declares the GoTransform class.
GoSetup::GoSetup_Tracheid
GoTracheid GoSetup_Tracheid(GoSetup setup, GoRole role)
Gets the tracheid configuration module.
GoSetup::GoSetup_SetBarHeight
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
GoSetup::GoSetup_SetActiveAreaY
kStatus GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value)
Sets the active area Y.
GoSetup::GoSetup_SetBackCameraExposure
kStatus GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the back camera exposure value.
GoSetup::GoSetup_SpacingInterval
k64f GoSetup_SpacingInterval(GoSetup setup, GoRole role)
Gets the spacing interval.
GoSetup::GoSetup_TransformedDataRegionZ
k64f GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role)
Gets the transformed data region Z value.
GoSetup::GoSetup_ActiveAreaXLimitMin
k64f GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_SetTriggerBurstEnabled
kStatus GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable)
This API is experimental and may change in a future release Enables the trigger burst.
GoSetup::GoSetup_ScanModeOptionCount
kSize GoSetup_ScanModeOptionCount(GoSetup setup)
Gets the scan mode option count.
GoSetup::GoSetup_TriggerGateEnabledSystemValue
kBool GoSetup_TriggerGateEnabledSystemValue(GoSetup setup)
Reports the trigger gate enabled system value.
GoSurfaceGeneration
Represents a surface generation configuration.
GoSetup::GoSetup_FrontCameraExposureLimitMax
k64f GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the front camera exposure setting.
GoSetup::GoSetup_SetBarHoleCount
kStatus GoSetup_SetBarHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration bar.
GoSdkDef.h
Essential SDK declarations.
GoSetup::GoSetup_EnableExternalInputZPulse
kStatus GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable)
Sets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_FrontCameraY
k32u GoSetup_FrontCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_SetEncoderSpacing
kStatus GoSetup_SetEncoderSpacing(GoSetup setup, k64f period)
Sets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_Advanced
GoAdvanced GoSetup_Advanced(GoSetup setup, GoRole role)
Gets the advanced acquisition module, used for advanced acquisition configuration.
GoSetup::GoSetup_BarHoleDistance
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_InputTriggerEnabledUsed
kBool GoSetup_InputTriggerEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user input trigger configuration is used.
GoSetup::GoSetup_BarWidth
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
GoSetup::GoSetup_InputTriggerEnabled
kBool GoSetup_InputTriggerEnabled(GoSetup setup)
Gets the input trigger enabled state.
GoSetup::GoSetup_IndependentExposuresEnabled
kBool GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role)
Determines if independent exposures feature is enabled.
GoSetup::GoSetup_SpacingIntervalLimitMin
k64f GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role)
Gets the spacing interval value limit minimum.
GoSetup::GoSetup_EnableIntensity
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
GoPartDetection
Represents the part detection parameters of the surface mode configuration.
GoSetup::GoSetup_SetTriggerSource
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
GoSetup::GoSetup_SetScanMode
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the scan mode.
GoSetup::GoSetup_SurfaceGeneration
GoSurfaceGeneration GoSetup_SurfaceGeneration(GoSetup setup)
Gets the surface generation module, used for surface generation configuration.
GoSetup::GoSetup_PartMatching
GoPartMatching GoSetup_PartMatching(GoSetup setup)
Gets the part matching module, used for part matching configuration.
GoSetup::GoSetup_SetAlignmentStationaryTarget
kStatus GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for stationary alignment calibration.
GoSetup::GoSetup_SetTrackingAreaHeight
kStatus GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the tracking window height.
GoSetup::GoSetup_AlignmentStationaryTargetOptionCount
kSize GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup)
Gets the stationary alignment target option count.
GoSetup::GoSetup_BarHeight
k64f GoSetup_BarHeight(GoSetup setup)
Gets the height of the bar used for travel calibration.
GoSetup::GoSetup_BackCameraY
k32u GoSetup_BackCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_TriggerGateEnabledUsed
kBool GoSetup_TriggerGateEnabledUsed(GoSetup setup)
Gets the system value representing whether or not the user specified trigger gate enabled setting is ...
GoSetup::GoSetup_ActiveAreaLengthLimitMin
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_SpacingIntervalSystemValue
k64f GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role)
Gets the spacing interval system value.
GoSetup::GoSetup_AlignmentStationaryTarget
GoAlignmentTarget GoSetup_AlignmentStationaryTarget(GoSetup setup)
Gets the target type used for stationary alignment calibration.
GoSetup::GoSetup_PatternSequenceTypeOptionAt
GoPatternSequenceType GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the pattern sequence type option at the given index.
GoSetup::GoSetup_FrameRateLimitMin
k64f GoSetup_FrameRateLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Frame Rate setting.
GoSetup::GoSetup_TransformedDataRegionWidth
k64f GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role)
Gets the transformed data region width value.
GoSetup::GoSetup_SetExposure
kStatus GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the exposure value.
GoSetup::GoSetup_LayoutMultiplexingBank
k32s GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role)
Gets Multiplex bank used state.
GoSetup::GoSetup_BarHoleCountUsed
kBool GoSetup_BarHoleCountUsed(GoSetup setup)
Indicates if the hole count can be modified by the user.
GoSetup::GoSetup_TriggerBurstCountUsed
kBool GoSetup_TriggerBurstCountUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enbaled state...
GoSetup::GoSetup_EnableFlickerFreeMode
kStatus GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable)
Enables flicker reduction mode.
GoSetup::GoSetup_TrackingAreaHeightLimitMin
k64f GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the tracking window height minimum limit.
GoSetup::GoSetup_ExternalInputZPulseEnabled
kBool GoSetup_ExternalInputZPulseEnabled(GoSetup setup)
Gets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_BarHoleDiameterUsed
kBool GoSetup_BarHoleDiameterUsed(GoSetup setup)
Indicates if the hole diameter can be modified by the user.
k32s
GoSetup::GoSetup_Layout
GoLayout GoSetup_Layout(GoSetup setup)
Gets the layout configuration module.
GoSetup::GoSetup_IntensityStepIndex
kSize GoSetup_IntensityStepIndex(GoSetup setup, GoRole role)
Gets the intensity step index.
GoTriggerUnits
Represents the system's primary synchronization domain.
GoSetup::GoSetup_SpacingIntervalTypeUsed
kBool GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role)
Gets the system value representing whether or not the user specified spacing interval type setting is...
GoSetup::GoSetup_ExposureStepAt
k64f GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index)
Get the exposure step value specified by index.
GoEncoderTriggerMode
Represents an encoder's triggering behavior.
GoSetup::GoSetup_TriggerDelayLimitMin
k64f GoSetup_TriggerDelayLimitMin(GoSetup setup)
Reports the minimum trigger delay, based on current settings.
GoSetup::GoSetup_BackCameraExposureLimitMax
k64f GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the back camera exposure setting.
GoSetup::GoSetup_SetActiveAreaZ
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
GoSetup::GoSetup_SetTriggerBurstCount
kStatus GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count)
This API is experimental and may change in a future release Sets the trigger burst count...
GoAlignmentTarget
Represents a alignment target type.
GoSetup::GoSetup_FrontCameraExposure
k64f GoSetup_FrontCameraExposure(GoSetup setup, GoRole role)
Gets the front camera exposure value.
GoSetup::GoSetup_LayoutMultiplexingBankUsed
kBool GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role)
Gets Multiplex bank used state.
GoExposureMode
Represents all possible exposure modes.
GoSetup::GoSetup_TriggerSource
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
GoSetup::GoSetup_SetPatternSequenceType
kStatus GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type)
Sets the pattern sequence type.
GoSetup::GoSetup_ClearExposureSteps
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
GoSetup::GoSetup_SetTriggerDelay
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
GoSurfaceGeneration.h
Declares the GoSurfaceGeneration class.
GoPatternSequenceType
Represents a pattern sequence type.
GoSetup::GoSetup_PlateHeight
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
GoSetup::GoSetup_ExposureLimitMin
k64f GoSetup_ExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the Exposure setting.
GoSetup::GoSetup_SetSpacingInterval
kStatus GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value)
Sets the spacing interval.
GoSetup::GoSetup_SetPlateHeight
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
GoSetup::GoSetup_TriggerDelayLimitMax
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
GoSetup::GoSetup_PatternSequenceTypeUsed
kBool GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the pattern sequence type is used.
GoSetup::GoSetup_ExposureModeOptionAt
GoExposureMode GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the exposure mode option at the given index.
GoSetup::GoSetup_LayoutGridDirectionSystemValue
k32s GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role)
Gets layout grid direction.
GoSetup::GoSetup_SetBarWidth
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
GoSetup::GoSetup_SetOcclusionReductionAlg
kStatus GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg)
Sets the occlusion reduction algorithm.
GoSetup::GoSetup_BackCameraWidth
k32u GoSetup_BackCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_PlateRefHoleDiameter
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_DynamicExposureMax
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
GoSpacingIntervalType
Represents spacing interval types.
GoSetup::GoSetup_ExposureStepCount
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
GoSetup::GoSetup_EnableInputTrigger
kStatus GoSetup_EnableInputTrigger(GoSetup setup, kBool enable)
Sets the input trigger enabled state.
GoSetup::GoSetup_DynamicExposureMin
k64f GoSetup_DynamicExposureMin(GoSetup setup, GoRole role)
Gets the minimum value for the Dynamic Exposure setting.
GoAlignmentType
Represents an alignment type.
GoSetup::GoSetup_MaxFrameRateEnabled
kBool GoSetup_MaxFrameRateEnabled(GoSetup setup)
Reports whether or not system is configured to operate at full frame rate.
GoSetup::GoSetup_PatternSequenceType
GoPatternSequenceType GoSetup_PatternSequenceType(GoSetup setup, GoRole role)
Gets the pattern sequence type.
GoSetup::GoSetup_EncoderSpacing
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_SetIntensitySource
kStatus GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source)
Sets the source to be used for generating intensity data.
GoSetup::GoSetup_ExposureModeOptionCount
kSize GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role)
Gets the exposure mode option count.
GoSetup::GoSetup_ActiveAreaHeight
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
GoSetup::GoSetup_EnableOcclusionReduction
kStatus GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable)
Sets the occlusion reduction enabled state.
GoSetup::GoSetup_TransformedDataRegionY
k64f GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role)
Gets the transformed data region Y value.
GoOcclusionReductionAlg
Represents an occlusion reduction algorithm.
GoSetup::GoSetup_ExposureMode
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoPartMatching
Represents the part matching parameters of the surface mode configuration.
GoSetup::GoSetup_TransformedDataRegionHeight
k64f GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role)
Gets the transformed data region height value.
GoSetup::GoSetup_TriggerBurstEnabledUsed
kBool GoSetup_TriggerBurstEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enbaled state...
kObject
GoMode
Represents a scan mode.
kStatus
GoSetup::GoSetup_FrontCameraExposureLimitMin
k64f GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the front camara exposure setting.
GoSetup::GoSetup_XSubsamplingOptionAt
k32u GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the x-resolution option at the specified index.
GoSetup::GoSetup_SetIntensityStepIndex
kStatus GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index)
Sets the intensity step index.
GoSetup::GoSetup_ActiveAreaZLimitMax
k64f GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_SpacingIntervalLimitMax
k64f GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role)
Gets the spacing interval value limit maximum.
GoSetup::GoSetup_ActiveAreaWidthLimitMin
k64f GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaWidth setting.
GoSetup::GoSetup_ActiveAreaYLimitMax
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_SetDynamicExposureMin
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
GoSetup::GoSetup_SetActiveAreaHeight
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value)
Sets the active area height.
GoSetup::GoSetup_ProfileGeneration
GoProfileGeneration GoSetup_ProfileGeneration(GoSetup setup)
Gets the profile generation module, used for profile generation configuration.
GoSetup::GoSetup_SetFrontCameraExposure
kStatus GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the front camera exposure value.
k64f
GoSetup::GoSetup_SetEncoderTriggerMode
kStatus GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode)
Sets the encoder trigger mode.
GoSetup::GoSetup_SpacingIntervalUsed
kBool GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role)
Returns the state of whether the user specified spacing interval is used.
GoSetup::GoSetup_OcclusionReductionEnabledSystemValue
kBool GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup)
Gets the occlusion reduction system value.
GoSetup::GoSetup_ScanMode
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the scan mode.
GoSetup::GoSetup_LayoutGridUsed
kBool GoSetup_LayoutGridUsed(GoSetup setup, GoRole role)
Gets layout grid used state.
GoSetup::GoSetup_FlickerFreeModeAvailable
kBool GoSetup_FlickerFreeModeAvailable(GoSetup setup)
Reports whether flicker free mode is available for use on this sensor.
GoSetup::GoSetup_ExposureLimitMax
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
GoSetup::GoSetup_SetBarHoleDiameter
kStatus GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of holes that are defined on the calibration bar.
GoSetup::GoSetup_TrackingAreaHeightLimitMax
k64f GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the tracking window height maximum limit.
GoSetup::GoSetup_FrontCameraHeight
k32u GoSetup_FrontCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
kBool
GoSetup::GoSetup_XSubsampling
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
GoSetup::GoSetup_EnableIndependentExposures
kStatus GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable)
Enables independent exposures feature, i.e.
GoSetup::GoSetup_SetTriggerUnit
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
GoSetup::GoSetup_BarHoleDiameter
k64f GoSetup_BarHoleDiameter(GoSetup setup)
Gets the diameter of holes that are defined on the calibration bar.
GoSetup
Represents a device configuration.
GoPartMatching.h
Declares the GoPartMatching class.
GoSetup::GoSetup_BackCameraExposureLimitMin
k64f GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the back camara exposure setting.
GoSetup::GoSetup_AlignmentTypeOptionAt
GoAlignmentType GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index)
Gets the alignment type option at the given index.
GoSetup::GoSetup_BarHoleDistanceUsed
kBool GoSetup_BarHoleDistanceUsed(GoSetup setup)
Indicates if the hole distance can be modified by the user.
GoSetup::GoSetup_TrackingEnabled
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
GoSetup::GoSetup_AlignmentEncoderCalibrateEnabled
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
GoSections
Represents the collection of sections and limits for defining them.
GoSetup::GoSetup_SetXSubsampling
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
GoLayout.h
Declares the GoLayout class.
GoSetup::GoSetup_ActiveAreaLength
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
GoSetup::GoSetup_SetPlateSecHoleDiameter
kStatus GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_EncoderSpacingLimitMax
k64f GoSetup_EncoderSpacingLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Encoder Period setting.
GoSetup::GoSetup_PartDetection
GoPartDetection GoSetup_PartDetection(GoSetup setup)
Gets the part detection module, used for part detection configuration.
GoSetup::GoSetup_ActiveAreaX
k64f GoSetup_ActiveAreaX(GoSetup setup, GoRole role)
Gets the active area x origin.