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