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