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